feat: 🎉 init project

.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+build
+coverage

.eslintrc.json

@@ -0,0 +1,27 @@
+{
+  "root": true,
+  "parserOptions": {
+    "ecmaVersion": 2021,
+    "sourceType": "module"
+  },
+  "ignorePatterns": ["node_modules", "build", "coverage"],
+  "env": {
+    "es6": true,
+    "node": true,
+    "browser": true,
+    "serviceworker": true
+  },
+  "plugins": ["jest", "prettier"],
+  "extends": ["plugin:jest/recommended", "prettier"],
+  "rules": {
+    "no-var": "error",
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "no-multi-spaces": "error",
+    "space-in-parens": "error",
+    "no-multiple-empty-lines": "error",
+    "prefer-const": "error",
+    "max-lines-per-function": ["warn", 40],
+    "no-shadow": "off",
+    "prettier/prettier": "error"
+  }
+}

.gitignore

@@ -0,0 +1,145 @@
+# dependencies
+node_modules
+jspm_packages/
+/.pnp
+.pnp.js
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+yarn commitlint --edit $1

.husky/common.sh

@@ -0,0 +1,8 @@
+command_exists () {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# Workaround for Windows 10, Git Bash and Yarn
+if command_exists winpty && test -t 1; then
+  exec < /dev/tty
+fi

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+yarn lint-staged

.prettierignore

@@ -0,0 +1,3 @@
+node_modules
+build
+coverage

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "semi": false,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "proseWrap": "never",
+  "endOfLine": "auto"
+}

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project! This document outlines some guidelines for contributing to our monorepo, which includes the server, client, and design components of our MERN stack project.
+
+## Types of Contributions
+
+We welcome the following types of contributions:
+
+- Bug fixes
+- Enhancements
+- New features
+- Documentation improvements
+
+## Basic Rules and Regulations
+
+- All contributions must follow our [Code of Conduct]()
+- Contributors must create pull requests and not commit directly to the repository.
+- Pull requests must include a clear description of the changes made.
+- Pull requests must include passing tests where applicable.
+- Pull requests must follow our commit message conventions. [Commit Message Conventions]()
+
+### We use the following conventions for commit messages:
+
+- feat: for new features
+- enhancement: for enhancements to existing features
+- bug-fix: for bug fixes
+- refactor: for code refactoring
+- docs: for documentation updates
+- style: for formatting and styling changes
+- test: for adding or updating tests
+- chore: for routine maintenance tasks, such as updating dependencies
+
+For example: `feat: Added new authentication method`
+
+### Submitting a Pull Request
+
+To submit a pull request:
+
+- Fork the repository and create a new branch for your changes.
+- Make your changes and commit them with clear commit messages following our conventions.
+- Push your changes to your forked repository.
+- Create a pull request with a clear description of the changes made and any relevant information.
+- Wait for a review from our team. We may ask for additional changes or information before merging your pull request.
+
+#### Advice on pull requests
+
+Pull requests are the easiest way to contribute changes to git repos at Github. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes.
+
+- You need a local "fork" of the Github repo.
+
+- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using "feature_x" as the example:
+
+  - Update your local git fork to the tip (of the master, usually)
+  - Create the feature branch with git checkout -b feature_x
+  - Edit changes and commit them locally
+  - Push them to your Github fork by git push -u origin feature_x. That creates the "feature_x" branch at your Github fork and sets it as the remote of this branch
+  - When you now visit Github, you should see a proposal to create a pull request
+
+- If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then use git push to automatically update the pull request.
+- If you need to change something in the existing pull request (e.g. to add a missing signed-off-by line to the commit message), you can use git push -f to overwrite the original commits. That is easy and safe when using a feature branch. Example workflow:
+  - Checkout the feature branch by git checkout feature_x
+  - Edit changes and commit them locally. If you are just updating the commit message in the last commit, you can use git commit --amend to do that
+  - If you added several new commits or made other changes that require cleaning up, you can use git rebase -i HEAD~X (X = number of commits to edit) to possibly squash some commits
+  - Push the changed commits to Github with git push -f to overwrite the original commits in the "feature_x" branch with the new ones. The pull request gets automatically updated
+
+> ‼ If you have commit access ‼
+>
+> - Do NOT use git push --force.
+> - Do NOT commit to other maintainer's packages without their consent.
+> - Use Pull Requests if you are unsure and to suggest changes to other maintainers.
+
+Thank you for contributing to our project! We appreciate your help in making it better.

License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 College Management 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,49 @@
+# College Management - IIIT Lucknow
+
+## Introduction
+
+## Configuration
+
+1. First, make sure you have Node.js and npm (Node Package Manager) installed on your computer, You can check this by running the following commands in your terminal:
+
+```
+    node -v
+    npm -v
+```
+
+> Read docs here [Node.js Documentation](https://nodejs.org/en/docs/)
+
+2. Once you have npm installed you can run the following both to install and upgrade Yarn
+
+```
+    npm install --global yarn
+    yarn --version
+```
+
+> Read docs here: [Yarn Installation guide](https://classic.yarnpkg.com/lang/en/docs/install)
+
+## Installation
+
+1. Fork the repo
+
+> Read docs here: [Forking a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
+
+2. Clone the project from the forked repo
+
+```
+    git clone https://github.com/<username>/<fork-name>
+```
+
+3. Once the project is cloned, navigate into the project directory and run the following command to install all the necessary dependencies:
+
+```
+    yarn install
+```
+
+4. Finally, to start the development server, run the following command in your terminal:
+
+```
+    yarn start
+```
+
+> This will start the development server - you should be able to see your client running at [`http://localhost:3000`](http://localhost:3000), the server running at [`http://localhost:5000`](http://localhost:5000)

client/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "extends": ["../.eslintrc.json"],
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "requireConfigFile": false,
+    "babelOptions": {
+      "presets": ["@babel/preset-react"]
+    }
+  }
+}

client/index.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>College Management | IIIT Lucknow</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <div class="portal"></div>
+    <script type="module" src="/src/index.jsx"></script>
+  </body>
+</html>