slashdot-iiserk / iiser-k-pwa

The one stop app for IISER K students

IISER K App

An one stop app for IISER K students

You can find the development version of the app here.

Getting Started

To get started, clone the repository locally on your pc.

# Using HTTPS
git clone https://github.com/slashdot-iiserk/IISER-K-PWA.git <project name>

or

# Using SSH
git clone [email protected]:slashdot-iiserk/IISER-K-PWA.git <project name>

Then follow the Setup section.

Setup

It is highly recommended that you use linux. Some things might not work right away on Windows. If you are on Windows, you can use WSL.

• Make sure that you have node.js and yarn installed. You can check for the same by running node -v and yarn -v. If you have them installed you will get a version number without error.
• Run yarn install. This should install all necessary packages into a node_modules folder.
• Run yarn dev to see if you are able to run the react app. If you did not face any errors you are good to go.

Recommended IDE Setup

It is recommended that you use VSCode for this project. TypeScript Vue Plugin (Volar).

• You need to have the following extensions installed:

  Necessary

  • Prettier - Code formatter
  • Volar
  • Tailwind CSS IntelliSense
  • ESlint
  • Better Comments
  • Visual Studio Code Commitizen Support

  Recommended

  • GitLens — Git supercharged
  • Git Graph

• Create a workspace settings.json file in .vscode directory in the root of the project. You can do this by opening the command palette(Ctrl+Shift+P) and entering Preferences: Open Workspace Settings (JSON). This will contain all the settings specific only to this project.

• Add the following lines in the settings.json file

  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",

Available Scripts

In the project root, you can run:

• Install (all) missing packages

  yarn install

• Compile and Hot-Reload for Development

  yarn dev

• Type-Check, Compile and Minify for Production

  yarn build

• Open a preview of the build locally

  yarn preview

• Run Unit Tests with Vitest

  yarn test:unit

• Run End-to-End Tests with Cypress

  yarn build
  yarn test:e2e # or `yarn test:e2e:ci` for headless testing

• Lint with ESLint

  yarn lint

• Open Commitizen menu

  yarn commit

iiser-k-pwa's Issues

Setup routing in the app

Add git hooks & github workflows

The following git hooks are added to the project:

• lint/format code before commit
• check for commit message to be in specific format
• check type before merging any pull request

Make the IISER K PWA installable

Add Scaffold ui for the app

Refer to #10 for more details regarding this.

Deploy the main branch

This main branch of this project has been deployed through vercel to this temporary url.

NOTE:

• The url will be used only during development.
• I couldn't deploy the project directly through this repo. So I have forked this repo and deployed that. The fork is at this link.
• Everytime a release is done, one has to sync the changes in the main branch to the fork. The new changes will be reflected within minutes/hours automatically