https://github.com/rakibul-islam-raju/subsify-api
https://github.com/rakibul-islam-raju/subsify-api
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rakibul-islam-raju/subsify-api
- Owner: rakibul-islam-raju
- Created: 2023-09-03T15:45:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-27T03:52:31.000Z (over 1 year ago)
- Last Synced: 2025-01-12T21:30:05.310Z (5 months ago)
- Language: TypeScript
- Size: 173 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Subsify
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Node.js and npm (Node Package Manager) or Yarn installed on your machine.
## Installation
1. Open your MongoDB management tool or use the command-line interface to create a new database named `subsify`
2. Duplicate the `.env.example` file and save it as `.env` in the root directory of your project. You can do this manually by creating a new file named .env and copying the contents of `.env.example` into it.
3. Clone this repository to your local machine and change your working directory to the project folder.
4. Install project dependencies using npm or Yarn.
- Yarn: `yarn install`
- NPM: `npm install`
## Usage
### Development
To run the project in development mode with auto-reloading on code changes, use the following command:
- Yarn: `yarn dev`
- NPM: `npm run dev`
### Production
To build the project for production, use the following command:
- Yarn: `yarn build`
- NPM: `npm run build`
### Start
To start the project in production mode after building, use:
- Yarn: `yarn start`
- NPM: `npm start`
### Testing
To run tests with Jest, use the following command:
- Yarn: `yarn test`
- NPM: `npm test`
## Database Diagram
