Thinslices Knowledge Base App

App Description

A study app for skill development, aimed to be used by developers. Users can document their own studies, structured as questions and answers, linked to a specific skill, and organised with tags (technologies, roles etc.). Users can also view studies created by other users, search for studies, add studies to their favourites list, give feedback, and receive reputation points for their contributions.

Use Cases

1. User Login: A user can log in to access the app and its features.
2. View Skills and Studies: A user can view a list of all available skills and view studies related to that skill.
3. Create a Study: A user can create a new study, which consists of a set of questions and answers, and link it to a specific skill.
4. View Own and All Studies: A user can view their own studies and all other studies created by other users.
5. Search Studies: A user can search for studies using keywords or skills.
6. Edit/Delete Own Studies: A user can edit or delete their own studies.
7. Add Studies to Favorites List: A user can add a study to their favorites list for future reference.
8. View Favorites List: A user can view a list of their favorite studies.
9. Reputation Points: A user can receive reputation points for creating studies, reading other studies, giving kudos or feedback.

Tech Stack

This is a T3 Stack project bootstrapped with create-t3-app.

If you are not familiar with the different technologies used in this project, please refer to the respective docs.

• Next.js
• NextAuth.js
• Prisma
• Tailwind CSS
• tRPC

Working locally

1. Clone the repo
2. Install dependencies
3. Update the environment variables in .env
4. Make sure you have Docker installed
5. Run npm run docker:db:init to start the database (first time only) or npm run docker:db:start to start the database (after first time)
6. Run npm run dev to start the app
7. [OPTIONAL] Install PGAdmin to manage the Postgres database