README.md

Backend

This is the backend for a curriculum builder project: a modular and free-to-use resume builder designed for individuals, allowing them to create, share, and download their resumes while featuring integrated social interaction.

Project Documents

• GitBook
• Prisma Diagram
• Endpoints

Tech Stack

Base

Database

Test

• supertest 😎

Linting and Formatting

Development

Others

• Argon2 🔐
• Faker 🪄
• Husky 🐶
• Nodemailer 💌

Recommended extensions for VS Code

• Code Spell Checker ✍️
• Docker 🐳
• ESLint 🛠️
• GitHub Pull Requests 🔗
• GitLens 🔍
• Jest 🤡
• Postman 📫
• Prettier 🎨
• Prisma 📊
• WSL 🖥️

Note

We strongly recommend using the Windows Subsystem Linux (WSL) for development.

How to start

Important

Before we start, you need to have Docker set up and running.

1. Clone this repository using git
2. In your terminal:
   1. yarn install
   2. yarn dev
   3. Done!🫖