From 9f514e5fb1525d92e79683c0ee06c2d658183724 Mon Sep 17 00:00:00 2001 From: Pratik Jallan <74804069+Yukino2002@users.noreply.github.com> Date: Thu, 12 Jan 2023 20:55:21 +0530 Subject: [PATCH] Refactor new website into its corresponding folder --- README.md | 36 ++--------------- .gitignore => new-website/.gitignore | 0 new-website/README.md | 38 ++++++++++++++++++ {deepchem => new-website/deepchem}/.bablerc | 0 .../deepchem}/.eslintrc.yml | 0 {deepchem => new-website/deepchem}/.gitignore | 0 {deepchem => new-website/deepchem}/README.md | 10 ++--- .../deepchem}/env-config.js | 0 .../deepchem}/next.config.js | 0 .../deepchem}/package-lock.json | 0 .../deepchem}/package.json | 0 .../deepchem}/postcss.config.js | 0 .../deepchem}/tailwind.config.js | 0 .../public}/assets/workflow.png | Bin 14 files changed, 46 insertions(+), 38 deletions(-) rename .gitignore => new-website/.gitignore (100%) create mode 100644 new-website/README.md rename {deepchem => new-website/deepchem}/.bablerc (100%) rename {deepchem => new-website/deepchem}/.eslintrc.yml (100%) rename {deepchem => new-website/deepchem}/.gitignore (100%) rename {deepchem => new-website/deepchem}/README.md (89%) rename {deepchem => new-website/deepchem}/env-config.js (100%) rename {deepchem => new-website/deepchem}/next.config.js (100%) rename {deepchem => new-website/deepchem}/package-lock.json (100%) rename {deepchem => new-website/deepchem}/package.json (100%) rename {deepchem => new-website/deepchem}/postcss.config.js (100%) rename {deepchem => new-website/deepchem}/tailwind.config.js (100%) rename {public => new-website/public}/assets/workflow.png (100%) diff --git a/README.md b/README.md index ca2f3124..16cf645c 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,8 @@ # deepchem.io -Website for DeepChem - https://deepchem.io. -## Instructions -### Setting Up -- Install dependencies using `npm i` in the `/deepchem/` directory +Website for deepchem https://deepchem.io. -### Run -- Execute `npm run dev` to start a dev server -- Run `npx next dev -H -p 3000` to test on mobile devices -### Build -- Execute `npm run build` +The static pages for the website will be maintained in this repo. They will be served automatically by [GitHub Pages](https://pages.github.com/). -### Lint -- Execute `npm run lint` - -## TechStack -- [Next-13](https://nextjs.org/blog/next-13) -- [TailwindCSS](https://tailwindcss.com/) - -## Features -- Models -- Datasets -- Tutorials - -## Links -- [UI/UX](https://www.figma.com/file/lx8RDjCI7XyzLeUMmP7tCw/DeepChem?node-id=0%3A1&t=fen0Nhme contributers - -## Adding users and contributers to the carousels in home page and about page -- To add an organisation to the `Used by Scientific Leaders` section, add the the logo of the new organisation to the `/deepchem/public/used-by ` directory -- To add an organisation to the `Companies and Universities developing Deepchem` section in the About page, add the the logo of the new organisation to the `/deepchem/public/about/companies-developing-deepchem` directory -- File names can be flexible, but should be meaningful and represent the organisation -- Files must be .png files with transparent backgrounds - -## Workflow - -![](./public/assets/workflow.png) \ No newline at end of file +The frontpage for the website is in index.html. \ No newline at end of file diff --git a/.gitignore b/new-website/.gitignore similarity index 100% rename from .gitignore rename to new-website/.gitignore diff --git a/new-website/README.md b/new-website/README.md new file mode 100644 index 00000000..ca2f3124 --- /dev/null +++ b/new-website/README.md @@ -0,0 +1,38 @@ +# deepchem.io +Website for DeepChem - https://deepchem.io. + +## Instructions +### Setting Up +- Install dependencies using `npm i` in the `/deepchem/` directory + +### Run +- Execute `npm run dev` to start a dev server +- Run `npx next dev -H -p 3000` to test on mobile devices + +### Build +- Execute `npm run build` + +### Lint +- Execute `npm run lint` + +## TechStack +- [Next-13](https://nextjs.org/blog/next-13) +- [TailwindCSS](https://tailwindcss.com/) + +## Features +- Models +- Datasets +- Tutorials + +## Links +- [UI/UX](https://www.figma.com/file/lx8RDjCI7XyzLeUMmP7tCw/DeepChem?node-id=0%3A1&t=fen0Nhme contributers + +## Adding users and contributers to the carousels in home page and about page +- To add an organisation to the `Used by Scientific Leaders` section, add the the logo of the new organisation to the `/deepchem/public/used-by ` directory +- To add an organisation to the `Companies and Universities developing Deepchem` section in the About page, add the the logo of the new organisation to the `/deepchem/public/about/companies-developing-deepchem` directory +- File names can be flexible, but should be meaningful and represent the organisation +- Files must be .png files with transparent backgrounds + +## Workflow + +![](./public/assets/workflow.png) \ No newline at end of file diff --git a/deepchem/.bablerc b/new-website/deepchem/.bablerc similarity index 100% rename from deepchem/.bablerc rename to new-website/deepchem/.bablerc diff --git a/deepchem/.eslintrc.yml b/new-website/deepchem/.eslintrc.yml similarity index 100% rename from deepchem/.eslintrc.yml rename to new-website/deepchem/.eslintrc.yml diff --git a/deepchem/.gitignore b/new-website/deepchem/.gitignore similarity index 100% rename from deepchem/.gitignore rename to new-website/deepchem/.gitignore diff --git a/deepchem/README.md b/new-website/deepchem/README.md similarity index 89% rename from deepchem/README.md rename to new-website/deepchem/README.md index 8f669d94..7608511a 100644 --- a/deepchem/README.md +++ b/new-website/deepchem/README.md @@ -17,11 +17,11 @@ ### .babelrc -This is a Babel configuration file for a project using the "next/babel" preset and no additional plugins +This is a Babel configuration file for a project using the "next/babel" preset and no additional plugins. ### .eslint.yml -This is a configuration file for ESLint, a tool that helps to maintain a consistent code style and catch potential errors in your JavaScript code. +This is a configuration file for ESLint, a tool that helps to maintain a consistent code style and catch potential errors in the JavaScript code. - The `env` field specifies that this configuration should be applied in a browser environment and that it should support ECMAScript 2021 features. @@ -36,13 +36,13 @@ This is a configuration file for ESLint, a tool that helps to maintain a consist - The `rules` field specifies that the `prettier/prettier` rule should be set to `error`, which will cause ESLint to report any violations of the Prettier code format as errors. Additionally, the `react/react-in-jsx-scope` rule is turned off, the `require-jsdoc` rule is set to 0, and the `react/prop-types` rule is turned off. This means that ESLint will not report an error if the 'react' is not in the scope of JSX, it will not require JSDoc comments and it will not check for PropTypes. ### env-config.js -`env-config.js` sets up environment variables for the project +`env-config.js` sets up environment variables for the project. ### next-.config.js `next-config.js` contains the configuration options for the project. Some things to note: -- The project has disabled the image optimization feature provided by Next.js. This is controlled by the images.unoptimized configuration option which is set to true. This setting is in place as the static export feature of Next.js is not compatible with the image optimization feature. In the context of this project, the impact of image optimization is considered minimal. +- The project has disabled the image optimization feature provided by Next.js. This is controlled by the `images.unoptimized` configuration option which is set to `true`. This setting is in place as the static export feature of Next.js is not compatible with the image optimization feature. In the context of this project, the impact of image optimization is considered minimal. - Depending on the environment, the assetPrefix configuration option is conditionally set. This is implemented to ensure that the application functions correctly when hosted on Github Pages. Read more about `next-config.js` [here](https://nextjs.org/docs/api-reference/next.config.js/introduction) @@ -56,7 +56,7 @@ Read more about `next-config.js` [here](https://nextjs.org/docs/api-reference/ne ### postcss.config.js - This is an autogenerated file, and needed for `tailwind` to work. -- No existing options have been changed and no additional options have been added +- No existing options have been changed and no additional options have been added. ### tailwind.config.js diff --git a/deepchem/env-config.js b/new-website/deepchem/env-config.js similarity index 100% rename from deepchem/env-config.js rename to new-website/deepchem/env-config.js diff --git a/deepchem/next.config.js b/new-website/deepchem/next.config.js similarity index 100% rename from deepchem/next.config.js rename to new-website/deepchem/next.config.js diff --git a/deepchem/package-lock.json b/new-website/deepchem/package-lock.json similarity index 100% rename from deepchem/package-lock.json rename to new-website/deepchem/package-lock.json diff --git a/deepchem/package.json b/new-website/deepchem/package.json similarity index 100% rename from deepchem/package.json rename to new-website/deepchem/package.json diff --git a/deepchem/postcss.config.js b/new-website/deepchem/postcss.config.js similarity index 100% rename from deepchem/postcss.config.js rename to new-website/deepchem/postcss.config.js diff --git a/deepchem/tailwind.config.js b/new-website/deepchem/tailwind.config.js similarity index 100% rename from deepchem/tailwind.config.js rename to new-website/deepchem/tailwind.config.js diff --git a/public/assets/workflow.png b/new-website/public/assets/workflow.png similarity index 100% rename from public/assets/workflow.png rename to new-website/public/assets/workflow.png