Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add readme #98

Merged
merged 5 commits into from
Jun 20, 2024
Merged

Add readme #98

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e4c2317
Updated readme
Aokijiop Jun 19, 2024
e6cae1d
Update readme
Aokijiop Jun 19, 2024
a6bdbd1
Merge branch 'main' into add-readme
Aokijiop Jun 20, 2024
c880809
Update readme
Aokijiop Jun 20, 2024
7d4edd6
Merge branch 'add-readme' of github.com:ctc-uci/aiss-frontend into ad…
Aokijiop Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 4 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# npo-frontend-template
# Achievement Institute for STEM Scholars Frontend

This template will be used to create all NPO frontend repos
This is the frontend for the Achievement Institute for STEM Scholars project.

## Setting up development environment

Expand Down Expand Up @@ -29,11 +29,6 @@ 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.

### `yarn storybook`

Runs Storybook.\
Open [http://localhost:6006/](http://localhost:6006) to view it in the browser.

### `yarn format`

Formats `.js`, `.jsx`, `.css` files with Prettier.\
Expand All @@ -49,20 +44,6 @@ Your app is ready to be deployed!

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

### `yarn 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.

## Storybook

This project has Storybook installed to help build UI components and pages in isolation. Read more about Storybook [here](https://storybook.js.org/).

## ESLint and Prettier

This project uses ESLint and Prettier to enforce the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
Expand Down Expand Up @@ -95,8 +76,8 @@ The configuration for lint-staged is inside the `lint-staged` object inside of `

The configuration for husky is in the `.husky` directory, located in the root of the project. Learn more about husky [here](https://typicode.github.io/husky/).

## Learn More about Create React App and React
## Learn More about Vite and React

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

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