https://github.com/rubikcon/blockgigs-mobile-version-backend
https://github.com/rubikcon/blockgigs-mobile-version-backend
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rubikcon/blockgigs-mobile-version-backend
- Owner: Rubikcon
- License: mit
- Created: 2024-11-18T11:29:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-23T17:23:20.000Z (over 1 year ago)
- Last Synced: 2025-05-07T07:47:29.746Z (about 1 year ago)
- Language: TypeScript
- Size: 113 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BlockGigs Server
## Description
Server for Block Gigs Application
## Prerequisites
1. Node.js - Make sure you have Node.js installed (v14 or higher recommended).
2. PostgreSQL - Install and run PostgreSQL locally or use a remote PostgreSQL server.
3. Nest CLI - Install the NestJS CLI globally if you haven’t already:
```
npm install -g @nestjs/cli
```
4 .env file - A .env file is required for setting database credentials and other environment variables.
## Installation
1. Install Dependencies
```
npm install
```
2. Set Up the .env File:
In the project root, create a .env file with the following variables. Replace with your actual credentials:
```
DB_HOST=localhost
DB_PORT=5432
DB_USER=root
DB_PASSWORD=
DB_NAME=
```
## Set up the database
Create the database
Ensure that the database specified in DB_NAME exists in your PostgreSQL server. Start postgresql server locally, and login with credentials. You can then create the database manually:
```
CREATE DATABASE ;
```
## Compile and run the project
1. Start PostgreSQL Server:
Make sure your PostgreSQL server is running locally or remotely and accessible via the credentials in your .env file.
2. Start the NestJS Server
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Run tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Deployment
When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
```bash
$ npm install -g mau
$ mau deploy
```
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
## Resources
Check out a few resources that may come in handy when working with NestJS:
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).