Tomb-WWW

Experimental frontend for Tomb.

Dependencies

• Node.js
• Yarn
• Next.js
• Docker

Development Setup

Install dependencies:

yarn install

Environment and Services

There is a .env.example file in the root of the project. Copy this file to .env.dev and fill in the values. See below for more information on each variable.

Next Auth Setup

NextAuth needs to know where it's running, and a secret to encrypt sessions with. Set:

NEXTAUTH_URL=<where_next_is_running>
NEXTAUTH_SECRET=<some_random_string>

For development the default values should be fine, but you can change them if you'd like.

Google Project Setup

This project relies on Google OAuth2.0 for authentication. You'll need to create a Google OAuth Client ID and Secret. You can do this by following the instructions here.

Once you have these secrets, store them in the .env.dev file you created above:

GOOGLE_CLIENT_ID=<client_id>
GOOGLE_CLIENT_SECRET=<client_secret>

Running with Docker

Build a development docker image:

docker-compose build

Run a development docker container:

docker-compose up

If you have a properly configured .env.dev file, the frontend will be available at http://localhost:3000.

Running Dev Server Locally

You can run this project locally without docker, if you prefer, but I'm not going to document that here. You will need to run Postgres locally and point your NextJs app at it, as demonstrated in the docker-compose.yml file.