Skip to content

Commit

Permalink
Added .json files into git
Browse files Browse the repository at this point in the history
  • Loading branch information
FeiyouG committed Mar 3, 2022
1 parent 05bbb27 commit 6866f0e
Show file tree
Hide file tree
Showing 11 changed files with 32,036 additions and 42 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Ignore all generated files
*.log
*.pyc
*.json

# Ignore .DS_Store files
*.DS_Store
Expand Down
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,42 @@ An interactive tool for teaching and learning molecular programming.

## Run this project

### Prerequisite

First, ensure `node.js` and `npm` are installed on your machine.

Then, clone the project and `cd` to the folder *server*. Run the following
command to install the dependencies for the server:
Then, clone and `cd` into the project.

### Set up the server

`cd` to the folder `server/`. Run
```shell
$ npm install express body-parser cors
$ npm init -y
```
to initialize an empty `package.json` inside `server/`. Open and add the following lines to
your `package.json`:

```json
"type": "module",
"scripts": {
"start": "nodemon index.js"
},
```

Next, run the following command to install the dependencies for the server:
```shell
$ npm install express body-parser cors nodemon
```
After all packages are installed,
run `npm start` to start the server. Make sure port 3000 is available as
the server will run in port 3000 by default
run `npm start` to start the server. Make sure `port 3000` is available as
the server will run in `port 3000` by default

### Set up the client

Next, `cd` to the folder *client* and run the following command to install all
`cd` to the folder `client/` and run the following command to install all
the dependencies:
```shell
$ npm install react react-dom reac-redux redux redux-thunk @material-ui/core axios d3
$ npm install react react-dom react-redux redux redux-thunk @material-ui/core axios d3
```
Finally, run `npm start` on the client. The client uses port 3000 as default
too, but it can automatically change to use another port if port 3000 isn't
Expand Down
70 changes: 70 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
Loading

0 comments on commit 6866f0e

Please sign in to comment.