Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/weebnetsu/bugtracker

A FOSS bug tracker inspired Trello and ClickUp
https://github.com/weebnetsu/bugtracker

bugtracker docker drag-and-drop fastapi postgresql react supabase-auth todoapp typescript

Last synced: about 2 months ago
JSON representation

A FOSS bug tracker inspired Trello and ClickUp

Awesome Lists containing this project

README

        

# Bug Tracker App

This is a bug tracker app inspired by Trello & ClickUp... We use Supabase for file storage and user auth, PostgreSQL for storing data, FastAPI for our API and React.js (TypeScript) as our frontend!

[Next.js](https://nextjs.org)
[Supabase](https://supabase.com)
[MongoDB](https://www.mongodb.com)
[TypeScript](https://www.typescriptlang.org/)
[Docker](https://www.docker.com)
[AntDesign](https://ant.design)

---

## Contents

- [Requirements](#requirements)
- [Env Variables](#env-variables)
- [Run App](#run-app)
- [Installing Dependencies](#install-all-deps)
- [Running App](#run)
- [Using Docker (Recommended)](#using-docker)
- [Checking Logs](#checking-logs)
- [Project Structure](#project-structure)
- [Helpful Links](#helpful-links)
- [Support Me](#support)
- [Changelog](#changelog)

---

## Requirements

- Node.js 16.0+
- MongoDB 5+

## ENV Variables

Add your variables to a `.env.local` file:

```
MONGO_URL=MONGO_URL=mongodb://localhost:27017

NEXT_PUBLIC_SUPABASE_URL=https://whatever.supabase.co

NEXT_PUBLIC_SUPABASE_KEY=averylonganonkeythatissafetoshowontheui
```

## Run App:

### Install All Deps

`npm i`

### Run

`npm start` - Note that using docker is the preferred method to run this app.

### Using Docker

Note that docker will only run the database.

`docker-compose up -d`

- MongoDB: mongodb://localhost:27017

### Checking Logs

`docker-compose logs`

These logs will contain all the logs from the client, api and database viewer, you can use `grep` to filter commands, such as `sudo docker-compose logs | grep -i "bug-tracker-db-1"`. To remove a specific result from the logs, you can use `sudo docker-compose logs | grep -wv "bug-tracker-pgadmin-compose-1"`, this will hide the logs that contains the text in the quotes.

## Project Structure

```
├── mongo - Dockers MongoDB storage
└── src - Site source code
├── constants - All site constants
├── db - Database connection and collections
├── models - TypeScript data models
├── pages - Site UI
├── styles - Site styling
├── types - Custom project types
└── utils - Utils such as custom functions
```

## Helpful Links

- [Next.js](https://nextjs.org/docs/getting-started)
- [Supabase](https://supabase.com/docs/reference/javascript/installing)

- [Supabase CLI](https://supabase.com/docs/guides/cli)

## Support

If you want to support me and what I do, please consider subscribing to my YouTube channel, [Steve's teacher](https://www.youtube.com/stevesteacher)!

## Changelog

## v2 (Next Level - Current)

Changes:

- FastAPI -> Next.js
- React -> Next.js
- MUI -> Ant Design
- Postgres -> MongoDB

## v1 (Fast Man)

[View Here](https://github.com/WeebNetsu/bugtracker/tree/old/fastapi)

Changes:

- json-server -> FastAPI
- json-server -> PostgreSQL

## v0 (Juicy Service)

[View Here](https://github.com/WeebNetsu/bugtracker/tree/old/json-server)