Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edugese/screenpulse-backend-api
Backend application built with Node.js and Express using TypeScript for strong and robust typing. It serves as the REST API integrated into the ScreenPulse-frontApp application.
https://github.com/edugese/screenpulse-backend-api
api-rest backend expressjs mongodb mongoose nodejs typescript
Last synced: 24 days ago
JSON representation
Backend application built with Node.js and Express using TypeScript for strong and robust typing. It serves as the REST API integrated into the ScreenPulse-frontApp application.
- Host: GitHub
- URL: https://github.com/edugese/screenpulse-backend-api
- Owner: EduGese
- Created: 2023-12-18T11:09:36.000Z (11 months ago)
- Default Branch: prod
- Last Pushed: 2024-05-08T10:42:55.000Z (6 months ago)
- Last Synced: 2024-10-04T04:21:08.419Z (about 2 months ago)
- Topics: api-rest, backend, expressjs, mongodb, mongoose, nodejs, typescript
- Language: TypeScript
- Homepage: https://sreenpulse.web.app/
- Size: 9.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ScreenPulse API REST 🚀
This backend application, built with Node.js and Express, serves as the REST API for the [ScreenPulse-frontApp](https://github.com/EduGese/ScreenPulse-frontApp). It utilizes TypeScript to ensure strong and robust typing, ensuring code reliability and maintainability.
## Introduction
ScreenPulse REST API acts as the backend server for the ScreenPulse-frontApp application, providing endpoints for user authentication, data management, and integration with external APIs such as OMDB.
## Installation
To install and set up the project locally, follow these steps:
1. Clone the repository: `git clone [repository URL]`
2. Navigate to the project directory: `cd [project directory]`
3. Install dependencies: `npm install`
4. Set up environment variables: Create a `.env` file and specify the required variables.
5. Start the server: `npm start`
## Usage
Once the server is running, you can make requests to the provided endpoints to perform various operations such as user authentication, data retrieval, and favorites management.
## Features ✨
- **Authentication:** User registration and login for authentication and authorization.
- **Data Protection and Security:** Ensures secure password hashing and authentication.
- **OMDB API Integration:** Retrieve movie, series, and video game information from the OMDB API.
- **Favorites Management:** CRUD operations to manage user favorites in the database.
## Technologies & Libraries Used 🛠️
- **Node.js:** Server-side JavaScript runtime environment.
- **Express.js:** Web application framework for Node.js.
- **Dotenv:** Library for managing environment variables.
- **Bcryptjs:** Library for secure password hashing.
- **Mongoose:** MongoDB object modeling tool.
- **MongoDB Atlas:** Cloud-based database service.
- **Axios:** Promise-based HTTP client for making requests to servers.
- **Render:** Hosting service.
## API documentaion
### User EndPoints
#### Login
Authenticates a user.
```http
POST /api/user/login
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `email` | `string` | **Required**. User email |
| `password` | `string` | **Required**. User password |
#### Register
Registers a new user.
```http
POST /api/user/register
```
| Field | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `userName` | `string` | **Required**. Username |
| `email` | `string` | **Required**. User email |
| `password` | `string` | **Required**. User password |
### OMDB EndPoints
#### Get All Movies
Retrieves all movies/series/videogames matching searching criteria from the OMDB API.
```http
POST /api/omdb
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `s` | `string` | **Required**. Search term |
| `type` | `string` | Type of media (movie, series, episode) |
| `y` | `string` | Year |
#### Get Movie info
Retrieves detailed information about a specific movie from the OMDB API.
```http
GET /api/omdb/:id
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `id` | `string` | **Required**. OMDB ID of the movie|
### Favorites EndPoints
#### Create Favorite
Creates a new favorite.
```http
POST /api/favorites/:id
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `id` | `string` | **Required**. User ID |
#### Get All Favorites
Retrieves all favorites of a user.
```http
GET /api/favorites/:id
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `id` | `string` | **Required**. User ID |
#### Delete Favorite
Deletes a favorite by ID.
```http
DELETE /api/favorites/:id/:userId
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `id` | `string` | **Required**. Required. ID of the favorite |
| `userId` | `string` | **Required**. User ID |
#### Update Favorite
Updates a favorite's description.
```http
PUT /api/favorites/:id/:userId
```
| Field | Type | Description |
| :-------- | :------- | :------------------------- |
| `id` | `string` | **Required**. Required. ID of the favorite |
| `userId` | `string` | **Required**. User ID |
| `description` | `string` | **Required**. New description for the favorite |
## Configuration 🔧
Configuration settings, including database URLs and CORS client URLs, are centralized in a `.env` file. This approach simplifies the management of environment variables and enhances the modularity of the codebase.
## Modular Structure 🧩
The application is structured into separate modules for core functionalities, such as users, API integration, and favorites management. Each module consists of independent controllers, routes, and services, promoting clear separation of concerns and efficient code organization.
## Contributing
Contributions are welcome! If you'd like to contribute to the project, please fork the repository, make your changes, and submit a pull request. Be sure to follow the project's coding standards and guidelines.
## License
This project is licensed under the [MIT License](#).