Skip to content

Commit

Permalink
Improve development setup
Browse files Browse the repository at this point in the history
Update dashboard .env files
Add one line to contribution docs
  • Loading branch information
dostuffthatmatters authored and empicano committed Nov 7, 2023
1 parent 4af8be7 commit 4007fe3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
8 changes: 8 additions & 0 deletions dashboard/.env.development
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# required | URL of the tenta server (no trailing slash!)
NEXT_PUBLIC_SERVER_URL="http://localhost:8421"

# optional | rendered on the login page
NEXT_PUBLIC_CONTACT_EMAIL="contact.email@login.page"

# optional | rendered in the header
NEXT_PUBLIC_INSTANCE_TITLE="Your Department Name"

2 changes: 1 addition & 1 deletion dashboard/.env.template
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ NEXT_PUBLIC_SERVER_URL="http://your-server-domain.com"
NEXT_PUBLIC_CONTACT_EMAIL="contact.email@login.page"

# optional | rendered in the header
NEXT_PUBLIC_INSTANCE_TITLE="Professorship of Environmental Sensing and Modeling"
NEXT_PUBLIC_INSTANCE_TITLE="Your Department Name"

5 changes: 4 additions & 1 deletion docs/pages/contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ We're very happy about any contributions to Tenta! ✨

## Development setup

### Server

- Clone the repository and switch into the `server` directory
- Install the Python version noted in `.python-version` (e.g. with `pyenv`)
- Install the [poetry package manager](https://github.com/python-poetry/poetry)
Expand All @@ -19,9 +21,10 @@ We're very happy about any contributions to Tenta! ✨
- Have [NodeJS](https://nodejs.org/en) version >= 16 installed on your machine
- Install the dependencies with `npm install`
- Start the dashboard in development mode with `npm run dev`; Use the username `happy-un1c0rn` and the password `12345678` to log in
- You can modify `.env.development` to point your development frontend to a different server
- The directory structure is explained by [NextJS](https://nextjs.org/) (version 13, app router)

## Documentation
### Documentation

- Clone the repository and switch into the `docs` directory
- Have [NodeJS](https://nodejs.org/en) version >= 16 installed on your machine
Expand Down

0 comments on commit 4007fe3

Please sign in to comment.