This is a Node.js API project for Yookatale.
These instructions will help you set up and run the project on your local machine.
- Node.js (v16.13.0 or higher)
- npm (v7.24.0 or higher)
Run the following command to install the project's dependencies:
npm install
Create a .env file in the root directory of the project and add your configuration settings. You can use the provided .env.sample file as a template.
# .env
PORT=3000
localDB=mongodb://localhost:27017/yookatale
PROD_DB = your-productionUrl
JWT_SECRET=your-secret-key
CLOUD_NAME: Cloudinary CLOUD_NAME,
API_KEY: Cloudinary API_KEY,
API_SECRET: Cloudinary API_SECRET,
npm run build - Build the TypeScript source files into JavaScript.
npm start - Start the server in production mode.
npm run dev - Start the server in development mode with automatic reloading.
To start the application in development mode, run:
npm run dev
The API will be accessible at http://localhost:5000 by default. You can change the port in the .env file.
/api/v1/order/ - Manage order-related operations.
/api/v1/auth/ - Authentication, User and login operations
-
Node.js - JavaScript runtime
-
Express.js - Web framework for Node.js
-
MongoDB - NoSQL database
-
Mongoose - MongoDB object modeling for Node.js
-
bcryptjs - Password hashing library
-
jsonwebtoken - JWT authentication library
-
cors - Cross-Origin Resource Sharing
-
dotenv - Environment variable management
-
Cloudinary - Image and Video Management for the Cloud
-
TypeScript - Typed JavaScript