QX Code API is the backend service for QX Code, a SaaS platform that allows users to generate fully customizable QR codes for free. This API is built using NestJS 10 and provides endpoints for managing QR code generation, authentication, and user data.
- NestJS 10 Framework – Scalable and modular backend architecture.
- Prisma ORM with LibSQL (Turso) – Efficient and scalable database access.
- JWT Authentication – Secure authentication using JSON Web Tokens.
- Passport.js Integration – Supports local and JWT authentication strategies.
- Docker Support – Easily deployable with Docker and Docker Compose.
- Backend: NestJS 10
- Database: Prisma with LibSQL (Turso)
- Authentication: Passport.js with bcrypt and JWT
- API Documentation: Swagger (if enabled)
- Deployment: Docker, AWS, or Vercel
Ensure you have the following installed:
- Node.js 18+
- pnpm (preferred package manager)
- Docker (optional for containerized deployment)
- Clone the repository:
git clone https://github.com/your-username/qxcode-api.git cd qxcode-api - Install dependencies:
pnpm install
- Set up environment variables:
- Copy
.env.exampleto.envand update the values accordingly.
- Copy
- Run database migrations (if applicable):
pnpm prisma migrate dev
- Start the development server:
The API should now be running at
pnpm start:dev
http://localhost:3000.
To start the API using Docker:
docker-compose up --build- Authentication
POST /auth/login– Authenticate and receive a JWT token.POST /auth/register– Register a new user.
- QR Code Generation
POST /qr/generate– Create a new customizable QR code.GET /qr/:id– Retrieve QR code details.
- User Management
GET /user/profile– Fetch user profile information.
We welcome contributions! Feel free to submit issues or pull requests to improve the project.
This project is licensed under the MIT License.
🚀 Built with love using NestJS and Prisma!