72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<img
|
|
src="https://git.gbrown.org/gib/techtracker/raw/branch/main/apps/next/public/favicon.png"
|
|
alt="Tech Tracker"
|
|
width="100"
|
|
>
|
|
<br>
|
|
<b>Tech Tracker</b>
|
|
<br>
|
|
</h1>
|
|
|
|
<details>
|
|
<summary>
|
|
<h2>How to run:</h2>
|
|
</summary>
|
|
|
|
### Clone the Repository & Install Dependencies
|
|
|
|
```bash
|
|
git clone https://git.gbrown.org/gib/techtracker.git
|
|
```
|
|
|
|
```bash
|
|
cd techtracker
|
|
```
|
|
|
|
I would recommend using [bun](https://bun.sh/) to install dependencies.
|
|
|
|
```bash
|
|
bun i
|
|
```
|
|
|
|
You will also need docker installed on whatever host you plan to run the Convex instance from, whether locally, or on a home server or a VPS or whatever. Or you can just use the Convex SaaS if you want to have a much easier time, probably. I wouldn't know!
|
|
|
|
### Add your environment variables
|
|
|
|
Copy the example environment variable files and paste them in the same directory named `.env`.
|
|
|
|
Environment variables for Next Application
|
|
```bash
|
|
cp ./apps/next/env.example ./apps/next/.env
|
|
```
|
|
|
|
Environment variables for Self Hosting Convex & Website with Docker
|
|
```bash
|
|
cp ./docker/env.example ./docker/.env
|
|
```
|
|
|
|
### Start self hosted convex & Next Web Application
|
|
|
|
The basic gist is to run the commands below after you have filled out the environment variables you plan to use, but you should ultimately follow the [guide they provide](https://github.com/get-convex/convex-backend/tree/main/self-hosted)
|
|
```bash
|
|
cd ./docker
|
|
sudo docker compose up -d
|
|
sudo docker compose exec convex-backend ./generate_admin_key.sh
|
|
```
|
|
|
|
### Start your development environment.
|
|
|
|
Run
|
|
|
|
```bash
|
|
bun dev
|
|
```
|
|
|
|
### Fin
|
|
|
|
I am sure I am missing a lot of stuff so feel free to open an issue if you have any questions or if you feel that I should add something here!
|
|
|
|
</details>
|