isume295 / SongAPI

SongManager API is a powerful and flexible RESTful service designed to efficiently manage information for songs. It provides a comprehensive set of endpoints and functionalities to create, retrieve, update, and delete song data, enabling seamless integration with various music applications and services

Welcome to My internship test project

please find the front-end repo for this project here

MySong-api

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [MySong-api ]

MySong-api SongManager API is a powerful and flexible RESTful service designed to efficiently manage information for songs. It provides a comprehensive set of endpoints and functionalities to create, retrieve, update, and delete song data, enabling seamless integration with various music applications and services

🛠 Built With

Tech Stack

• Experss
• MongoDB
• Docker

Key Features

• Ease of use: Clear and well-documented interface that is easy for developers to understand and use.
• Scalability: Designed to handle a large number of requests and be able to scale horizontally to accommodate increasing demand.
• Reliability: APIs should be highly reliable and available, minimizing downtime and providing error handling mechanisms. This includes proper handling of errors and returning meaningful error messages.

(back to top)

-->

💻 Getting Started

To get a local copy up and running, follow these steps:

• Clone this repo as described in the setup section.
• Make modifications as peferred

Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone [e-mail]:isume295/SongAPI.git

For more information on how to clone or fork a repository:

• How to clone a repo
• How to fork a repo

Add a .env file in the root directory with the provided information, follow these instructions:

• Open a text editor or an integrated development environment (IDE) of your choice.
• Create a new file and save it in the root directory of your project (the top-level directory).
• Name the file .env (with a leading dot) to ensure it is recognized as an environment file.
• Inside the .env file, add the following lines:

MONGO_USERNAME="your mongo db username"
MONGO_PASSWORD="your mongo db password"
SERVER_PORT=your host number

Install

• Run npm install

Usage

To run the project, execute the following command:

• Run npm start

👥 Author

👤 Sumeya Ibrahim

• GitHub: @isume295

🔭 Future Features

Future changes:

• Store audio file for each song

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Thanks to Addis Software

(back to top)

📝 License

This project is MIT licensed.

(back to top)