Skip to content

Commit

Permalink
Refactor new website into its corresponding folder
Browse files Browse the repository at this point in the history
  • Loading branch information
Yukino2002 committed Jan 12, 2023
1 parent e0e78e3 commit 9f514e5
Show file tree
Hide file tree
Showing 14 changed files with 46 additions and 38 deletions.
36 changes: 3 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <hotspot-ip> -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)
The frontpage for the website is in index.html.
File renamed without changes.
38 changes: 38 additions & 0 deletions new-website/README.md
Original file line number Diff line number Diff line change
@@ -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 <hotspot-ip> -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)
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions deepchem/README.md → new-website/deepchem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)
Expand All @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes

0 comments on commit 9f514e5

Please sign in to comment.