https://github.com/audio-engineer/nova-dashboard-front-end
Next.js front end for Nova Dashboard project
https://github.com/audio-engineer/nova-dashboard-front-end
front-end javascript nextjs nodejs npm typescript
Last synced: 5 months ago
JSON representation
Next.js front end for Nova Dashboard project
- Host: GitHub
- URL: https://github.com/audio-engineer/nova-dashboard-front-end
- Owner: audio-engineer
- Created: 2024-09-28T12:54:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-11T19:56:23.000Z (over 1 year ago)
- Last Synced: 2024-11-11T20:32:11.073Z (over 1 year ago)
- Topics: front-end, javascript, nextjs, nodejs, npm, typescript
- Language: TypeScript
- Homepage:
- Size: 181 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Nova Dashboard Front End
This is the main frontend repository for the software part of a P3 project created by SW3 group 6 at
Aalborg University in Copenhagen.
## Local Development
Copy [`.env.local.sample`](./.env.local.sample) into `.env.local` and fill out the values for the
environment variables in the `.env.local` file.
### Running the local development environment
To start the Docker Compose project, run:
```shell
docker compose up -d
```
or, when using JetBrains WebStorm, by running the `Docker Compose` run configuration.
Then, start a new shell session in the `node` container:
```shell
docker exec -it nova-dashboard-front-end-node-1 /bin/sh
```
The first time the project is cloned, or when dependencies in [`package.json`](./package.json) or
[`package-lock.json`](./package-lock.json) have changed, in the `node` container run:
```shell
npm install
```
Now the development server can be started in the `node` container:
```shell
npm run dev
```
The front end is now accessible at [localhost:3000](http://localhost:3000/).
When code is pushed to the remote repository, the
[Formatting, Linting and Build](./.github/workflows/formatting-linting-and-build.yml) workflow is
run.
Therefore, check your code for errors before committing and pushing by running the tools in the
`node` container first:
```shell
npm run prettier && npx eslint .
```
To check whether the project can be compiled for production, run the `build` command:
```shell
NODE_ENV=production npm run build
```
Then, start the production server with:
```shell
NODE_ENV=production npm run start
```
After a finished development cycle, exit the `node` container and run:
```shell
docker compose down
```