https://github.com/lordksix/nextadventure-backend
Flight booking application. Node.js based framework, NestJS. Back-end
https://github.com/lordksix/nextadventure-backend
Last synced: about 2 months ago
JSON representation
Flight booking application. Node.js based framework, NestJS. Back-end
- Host: GitHub
- URL: https://github.com/lordksix/nextadventure-backend
- Owner: lordksix
- License: gpl-3.0
- Created: 2023-10-22T03:32:31.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-10-29T18:39:33.000Z (over 1 year ago)
- Last Synced: 2024-05-17T15:48:27.398Z (about 1 year ago)
- Language: TypeScript
- Size: 511 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Next Adventure App
# 📗 Table of Contents
- [📗 Table of Contents](#table-of-contents)
- [📖 Budget by Lordksix](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#Authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#️support)
- [🙏 Acknowledgments](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
**Next Adventure App** is the back end of the Next Adventure App. Build using NestJS and PostgreSQL as database. It allows you to look for and book flights and login with Facebook and GOogle.
Server
Database
- **Gitflow**
- **Implement Model Migrations**
- **Setup JWT**
- **Setup Guards**
- **Implement authentication**
- **Use PostgreSQL**
- **Implement Factory builder and seeders**
> The backend is being deploy to [Live Demo](https://next-adventure-lordksix.onrender.com).
### Prerequisites
In order to run this project you need:
- To clone or fork this repo
- Have Nest CLI install and Node.js
- PostgreSQL install in you computer
- To modify this profile you will also need a text editor
For more information on how to install ruby on your machine:
- How to install Node.js
- How to install Nestjs
### Setup
Clone this repository to your desired folder:
For example, using Ubuntu:
```sh
cd my-desired-folder
git clone https://github.com/lordksix/NextAdventure-backend.git
```
For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo
### Install
To install dependencies, the following command must be run in the terminal:
```sh
cd NextAdventure-backend
npm i
```
Run:
```bash
cp .env.example .env
```
Update DATABASE_PG_PASSWORD and SESSION_SECRET in .env file
To create database, migrate schema and implement initial database entries
```sh
npm run db:create && npm run migrations:run && npm run reseed
```
### Usage
In the project directory, run:
```sh
npm run start:dev
```
### Run tests
No tests implemented
👤 **lordksix**
- GitHub: [@lordksix](https://github.com/lordksix)
- LinkedIn: [@wladpasquel](https://www.linkedin.com/in/wladpasquel/)
- Medium: [@wladimir.pasquel](https://medium.com/@wladimir.pasquel)
Future changes:
- Finish implementing JWT
- Finish local, Google and Facebook login
- Implement testing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
- Life is awesome!!!
This project is [GNU v3](./LICENSE) licensed.