College-View

Your one stop destination to view all your college and student data intuitively

Documentation

Coming Soon

Try Online

The frontend is deployed on gh-pages. Have fun 😎

Run Locally

Running backend

1. Seed mongodb

To seed collections with random data run:

cd backend/seed
node seedCollege.js
node seedStudent.js
node seedStudentNum.js

Note: Please maintain the same order of execution

2. Setup .env file

Create .env and add MONGODB_URI values from previous step

3. Running server

Finally, the awaited step npm run start

Running frontend

The frontend are static html files. They can be served using any web server. For convenient use, we'll use serve.

# Install serve globally
sudo npm i -g serve
# Serve the frontend
cd frontend && serve

Linting

The project uses eslint and prettier to lint the files.The configuration files are .eslintrc, .eslintignore and .prettierignore.
You can manually lint code using

npm run lint

Author

Bhumij Gupta

---

if (repo.isAwesome || repo.isHelpful) {
  StarRepo();
}