Opportunities Bulletin Frontend

This repo hosts the frontend code for https://opportunities.stuysu.org. We use React, Apollo GraphQL, and Material UI to build the frontend.

Getting Started

DEVELOPMENT

1. Clone the repo
2. Ensure variables in constants.js are set to the correct values that you want to use.
3. Run npm install to install dependencies.
4. Run npm start to start the development server, and in another terminal, run npm run tailwind to start the Tailwind CSS compiler.
5. Code away!

PRODUCTION

1. Clone the repo
2. Ensure variables in constants.js are set to the correct values that you want to use.
3. Run npm install to install dependencies.
4. Run npm run build to build the production version of the site.
5. Serve the build folder using a web server of your choice.

Contributing

This site is meant to be built specifically by Stuyvesant Student Union IT, but we welcome and encourage contributions from the community. If you would like to contribute, please fork the repo and submit a pull request. We will review your code and merge it if it is up to our standards.

License

MIT

Contact

If you have any questions, please open an issue or contact us at mailto://redacted@example.invalid.