-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7bc7583
commit ba53021
Showing
1 changed file
with
16 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,34 @@ | ||
| # Getting Started with Create React App | ||
| # Stuy Scheduler | ||
| A little web tool to generate schedule listings in the formats various websites in the Stuyvesant HS community use. | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| It currently supports the [Andy-Fin Caucus](https://sophomore.stuysu.org) and [today.stuysu.org](today.stuysu.org) database formats, and contributions for new formats are welcomed! | ||
|
|
||
| ## Available Scripts | ||
| This is a [Create React App](https://github.com/facebook/create-react-app) + [MUI](https://mui.com/) project. | ||
|
|
||
| ## Quickstart | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
| Clone the repository and install its dependencies. | ||
| ```shell | ||
| git clone https://github.com/TheEgghead27/stuy-scheduler.git | ||
| cd stuy-scheduler | ||
| npm install | ||
| ``` | ||
| Now you can run the following scripts. | ||
|
|
||
| ### `npm start` | ||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
|
|
||
| The page will reload if you make edits.\ | ||
| You will 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). | ||
| The build is minified and the filenames include the hashes. | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
| Our [GitHub Pages](.github/workflows/pages.yml) deployment uses this to deploy the site to https://theegghead27.github.io/stuy-scheduler/. |