Aluraflix Server

Aluraflix is an application developed in Edition #2 of Alura Challenges, which consists of allowing users to assemble playlists with links to their favorite videos, separated by category.

Edition #2 of Alura Challenges: Develop a Rest API from scratch, choosing languages and technologies, a 4-week challenge to implement a system from database to testing and deployment, with support from experts via Discord.

📌 Table of contents

• Technologies
  • Code standards
• Getting started
• How to run
  • How to run test
• How to contribute to the project
• License

⚡ Technologies

This project was developed with the following technologies:

• Node.js
• TypeScript
• Express
• Prisma
• JSON Web Tokens
• TSyringe
• Celebrate

🎈 Code standards

• ESLint
• Prettier
• EditorConfig

💻 Getting started

Before you begin, you will need to have the following tools installed on your machine:

• Git

The project can be built with npm or yarn, so choose one of the approach bellow in case you don't have any installed on your system.

Npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer.

• Node.js v16.14.2 or heigher.

Yarn is a package manager created by the Facebook team and seems to be faster than npm in general.

• Yarn v1.22.18 or heigher.

The project uses a database (Postgres), it is necessary to have it on your machine so that you can run it. If not, I suggest using Docker Compose to run a container with the postgres image.

• Docker Compose

How to run database with Docker Compose locally (linux)

docker-compose up -d

Also, it’s good to have an editor to work with the code like VSCode.

ℹ️ How to run

Follow the instructions below to download and use the project from this repository:

You can use yarn or npm as package manager to run this project, but preferably I use npm.

Clone this repository using SSH:

git clone git@github.com:danielhessell/aluraflix-server.git

or clone using https:

git clone git@github.com:danielhessell/aluraflix-server.git

Go to project folder in terminal/cmd:

cd aluraflix-server

Install dependencies:

npm install --legacy-peer-deps

Remember to copy the .env.example file to an .env file, changing the information according to your environment.

Run migrations:

npx prisma generate && npx prisma migrate dev

Run project:

npm run dev:server

The server will start on port 3333. Go to http://localhost:3333.

✔️ How to run tests

This project has unit and integration testing. Run npm test.

🎉 How to contribute to the project

1. Fork the project
2. Create a new branch with your changes: git checkout -b my-feature
3. Save the changes and create a commit message telling what you've done: git commit -m "feature: My new feature"
4. Submit your changes: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub.

📄 License

This project is under the MIT license. See the LICENSE file for more details.

---

Made with 💙 by Daniel Hessel.