Flyspray

[rawdaGastan]

Description

It's a web-based bug tracking system.

Requirements

Backend

models:

• JWT claims (user_id, email, claims...)
• user (ID, name, email, hashed_password, verification_code, admin, verified...)
• member in project(ID, user_id, project_id, admin...)
• project (ID, name, created_at...)
• component (ID, project_id, name, created_at...)
• bug (ID, user_id, component_id, category, severity, summary, status, votes, opened, opened_at, updated_at...)
• comment (ID, user_id, bug_id, summary, created_at...)

endpoints:

• /user/signin a POST restful API to make the user sign in and return the token of the user

• /user/signup a POST restful API to register the user and create his account

• /user/signup/verify a POST restful API to verify the user email to complete the sign up

• /user/refresh_token a POST restful API to refresh the user token

• /user a GET restful API to get a user with its ID (needs authorization)

• /user a PUT restful API to update a user with its ID (needs authorization)

• /project a POST restful API to create a new project (needs authorization)

• /project/{id} a GET restful API to get a project with its ID (needs authorization)

• /project/{id} a Delete restful API to delete a project with its ID (needs authorization)

• /project/filters? a GET restful API to get all projects for a user (needs authorization)

• /member a POST restful API to add a new member (needs authorization)

• /member a PUT restful API to change the ownership of a member (needs authorization)

• /component a POST restful API to create a new component (needs authorization)

• /component/{id} a GET restful API to get a component with its ID (needs authorization)

• /component/{id} a Delete restful API to delete a component with its ID (needs authorization)

• /component/filters? a GET restful API to get all components for a project (needs authorization)

• /bug a POST restful API to create a new bug (needs authorization)

• /bug/{id} a PUT restful API to update a bug with its ID (needs authorization)

• /bug/{id} a GET restful API to get a bug with its ID (needs authorization)

• /bug/{id} a Delete restful API to delete a bug with its ID (needs authorization)

• /bug/filters? a GET restful API to get all bugs for a component (needs authorization)

• /comment a POST restful API to create a new comment (needs authorization)

• /comment/{id} a GET restful API to get a comment with its ID (needs authorization)

• /comment/{id} a DELETE restful API to delete a comment with its ID (needs authorization)

• /comment a GET restful API to get all comments for a bug (needs authorization)

DB:

• recommended for your DB: gorm.io/gorm

validator:

• recommended for your API bodies: gopkg.in/validator.v2

middle-wares:

• Authorization for the APIs which need it
• Cors (to be able to use your APIs in the frontend part)

configuration: (it's recommended to use JSON for your configs)

• server port
• mail sender configs (email, send grid key, timeout for sign up code expiration)
• db file path
• JWT configs (secret, token timeout)

extra: make sure your backend server has

• workflows (test-lint)
• dockerfile
• cmd entrypoint
• build
• tests
• swagger
• a good doc
• makefile

Frontend

to be added

Docker compose

make sure to add a docker compose for your backend server and frontend

References

• https://github.com/flyspray/flyspray
• https://bugs.archlinux.org/