Playify - Backend

Playify - Clean Architecture Pattern

This is the backend of my Playify app using Typescript, NodeJS, Express and a Clean Architecture Pattern

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact

About The Project

Playify is a small Spotify like web app, builded following the Clean Architecture pattern.

(back to top)

Built With

• Clean Architecture Pattern
• Typescript
• NodeJS
• Express
• MongoDB Atlas
• Jest (Unit testing)

(back to top)

Getting Started

Rename .env.template to .env or simply change your personnal ATLAS_URI && ATLAS_TEST_URI.

Installation

1. Clone the repo

   git clone https://github.com/tempSt69/playify-backend.git

2. Install NPM packages

   npm install

3. Start the project locally

   npm run dev

4. Run tests

   npm run test

5. To build the project and serve it

   npm run dev:build
   npm run dev:serve

   (back to top)

Roadmap

• Main CRUD
• Streaming service
• Search service
• Auto recommendation

(back to top)

Contact

Antoine Di Roberto - - antoine.diroberto@gmail.com

Project Link: https://github.com/tempSt69/playify-backend

(back to top)