Skip to content

Hari-Kumar-A/Student-Organiser

Repository files navigation

Student-Organiser

Student Organiser , a student-friendly application for academic needs.

🛠️ Tech Stack :

EJS  CSS  HTML  Mongodb  NodeJS  Express 

Features

  1. Authentication System
  2. Usage of Express Session
  3. MongoDB CRUD Operation
  4. EJS , Partials, Layouts
  5. Add , Edit, Delete, Search Filter for Events and Expenses
  6. Calendaer View
  7. Usage of Full Calendar
  8. Syncing with Google Calendar only after setting up googlecalendarID and API credentials in .env file
  9. They can upload their Grades and calculate GPA
  10. Students can add expenses (date, amount, category)
  11. They can set budget limit for category wise( like stationary, food, accomodation)
  12. They can view by categorywise by search filter

Installation and Setup

  1. Fork the Repo
  2. Clone the Repo:
$ git clone https://github.com/Hari-Kumar-A/Student-Organiser.git 
cd Student-Organiser/
  1. Install the packages:
npm install
  1. Setup env file, refer Google-Calendar API Integration
copy .env.example   .env
  1. Setup keys.json file, refer Google-Calendar API Integration
copy keys.json.example   keys.json
  1. Make sure, mongoDB is installed and is connected.

The server should be running at your 127.0.0.1 port 3002 (or the port specified in .env).


Resources

HTML
EJS
CSS
Mongoose
Express Js
Google-Calendar API Integration
Bcrypt

Contributing Guidelines

  1. Add a reference to the original repository.
https://github.com/Hari-Kumar-A/Student-Organiser
  1. Check the remotes for this repository.
git remote -v
  1. Always take a pull from the upstream repository to your main branch to keep it at par with the main project(updated repository).
git pull upstream main
  1. Once the issue is assigned. Create a new branch (DO NOT name it MAIN or MASTER or anything random). like to enhance blogs,it can be "enhanceBlog"
git checkout -b <your_branch_name>
  1. Perfom your desired changes to the code base.
    • Make sure that you do not change any code unrelated to the task that you have been assigned
    • Do not mess up the directory structure
    • Preview your changes and test them properly before proceding ahead
  2. Track your changes:
git add.
  1. Commit your changes:
git commit -m "Relevant message"  (usually title of the pull request)
  1. Push the committed changes in your feature branch to your remote repo:
git push -u origin <your_branch_name>
  1. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.
image
  1. Add an appropriate title and description to your pull request that explains your changes and efforts done.
  2. Click on
Create Pull Request
  1. Make sure to refer the respective issue in the respective PR using phrases like Resolves #issue_number or Fixes #issue_number. Here's an example to raise a PR:
 Fixes #2

# Work Done:
- Fixed blog page
- Made the Favicon more optimized
- ...
# Relevant Screenshots
  1. Hurray ❗ You have made a PR to the awesome Student Organiser project 💥 . Wait your PR to be reviewed.

ScreenShots

image image image

About

Student Organiser , a student-friendly application for academic needs

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published