nkss-dev / nkss-old-web-frontend

Web Frontend of the NIT KKR Student Support System!

Status 301: Moved permanently to web-front-end

We have decided to rewrite the web-front-end to remove code smells from its root and to also smoothen our transition to using the Next.js framework instead for the front-end of NKSSS' webpage. Following this, a new repository has been created on which all future work shall be done.

---

NKSS Web Frontend

This repository holds the source tree for the web frontend of NIT KKR Student Support System. The project is using Typescript as the language of choice with the ReactJS web framework. Cypress is being used for testing. You need to have NodeJS and npm installed locally to run this app.

Steps to run the project locally

1. Clone the repository locally, using the command

git clone [e-mail]:NIT-KKR-Student-Support-System/nkss-web-frontend.git

2. Move into the project directory

cd nkss-web-frontend

3. Install the required dependencies

npm install

4. Start the app locally

npm run start

The above command will start the app locally on your system with a webpack server running on port 3000

5. To get a production build of the app, you can run

npm run build

which can then be served locally using something like serve.

If you are looking to contribute be sure to checkout CONTRIBUTING.md