1
Fork 0
mirror of https://github.com/Steffo99/todocolors.git synced 2024-10-16 07:17:28 +00:00

Add development instructions and improve development environment for todoblue

This commit is contained in:
Steffo 2023-10-12 11:03:56 +02:00
parent 4fd40e1685
commit 9298337c2b
2 changed files with 43 additions and 0 deletions

View file

@ -43,6 +43,12 @@ Build instructions are provided for the two modules:
- [todored](todored/BUILD.md)
- [todoblue](todoblue/BUILD.md)
## Development
Development instructions are provided for the two modules:
- [todored](todored/DEVELOP.md)
- [todoblue](todoblue/DEVELOP.md)
## License
This project is licensed under the [AGPL-3.0-or-later](./LICENSE.txt).

37
todoblue/DEVELOP.md Normal file
View file

@ -0,0 +1,37 @@
# Development
## Prerequisites
To run `todoblue` locally for development, the following software must be installed on your local machine:
- [Node.JS](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
## Dependencies
Before being able to run `todoblue`, dependencies must be installed via Yarn:
```console
$ yarn install
```
As with all Node.JS applications, dependencies are placed in the `node_modules/` directory.
## Configuration
Development `todoblue` instances require some environment variables to be set:
```dotenv
# The URL where the todored backend can be found at.
NEXT_PUBLIC_TODOBLUE_OVERRIDE_BASE_URL=http://ethernet.nitro.home.steffo.eu:8080
```
## Running
A run-script is provided for running the development server, and it can be run via Yarn:
```console
$ yarn run dev --port=8081
```
An HTTP server serving the local version of `todoblue` with hot-reload will become available on port `:8081`.