- You might need to have NPM or yarn (yarn recommeded)
- In the project directory, run
npm install
oryarn install
depending on which you have. - Then run
yarn run dev
and open your browser tohttp://localhost:5000
to start working on the project. - To build the project run
npm run build
. - To serve the built project run
yarn start
.
This is an open source software project and I encourage developers to contribute patches and code for us to include in the main website of DSC NIT Trichy. All contributions will be fully credited.
- Feel free to use GitHub issues for questions, bug reports, and feature requests
- Use the search feature to check for an existing issue
- Include as much information as possible and provide any relevant resources (Eg. screenshots)
- For bug reports ensure you have a reproducible test case
- A pull request with a breaking test would be super preferable here but isn't required