https://github.com/hyperjumptech/hansip-web
https://github.com/hyperjumptech/hansip-web
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hyperjumptech/hansip-web
- Owner: hyperjumptech
- Created: 2020-10-07T05:08:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T07:07:09.000Z (over 5 years ago)
- Last Synced: 2025-06-04T00:24:20.211Z (11 months ago)
- Language: TypeScript
- Size: 286 KB
- Stars: 2
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hansip Front-end
## About
This is the front end web application for Hansip.
## Tech stack
1. [Next.JS](https://nextjs.org/).
2. [SWR](https://github.com/vercel/swr): to manage data fetching.
3. [Tailwind CSS](https://tailwindcss.com/): for styling.
## Requirements
1. [NodeJS](https://nodejs.org/en/).
2. [Yarn](https://yarnpkg.com/).
3. Hansip API server.
## Getting Started
1. Clone this repository
2. Run `yarn`
3. Run `cp .env.local.template .env.local`
4. Edit the Hansip API URL in .env.local if needed.
5. Run Hansip API server if needed.
6. Run `yarn dev`
## Directory Structure
1. `pages`: each of the files in this directory is associated with [a route based on its file name](https://nextjs.org/docs/basic-features/pages).
2. `data`: files related to data fetching, data types, etc.
3. `components`: React components that are used in the web application.
## Deployment
1. Edit the value of `NEXT_PUBLIC_API_URL` in the `.env.local` file.
2. Run `yarn build` to create optimized production build.
3. Run `yarn start` to run the web application. By default, the application runs in port 3000. To change the port, run `yarn start -p `
## TODO
1. Add tests.
2. Fix storybook.