Oud Front-End

Table of Contents

• About the Project
  • Build with
• Getting Started
  • Installation
  • Running
• Screenshots
• Videos
• File Structure
• Unit Testing
  • Running Unit tests
  • Generating Coverage Report
• Functional Documentation
• Contributing
• Contributors
• License

About The Project

Oud is an online music streaming service which is a mimic of Spotify with all its functionalities

Build with

• React JS
• React Router
• Bootstrap
• Jest
• Enzyme
• JSDOC
• Json-Server
• Axios

Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.

Installation

1. Clone the repository

$ git clone https://github.com/AbdallahHemdan/oudFrontend.git

2. Navigate to repository directory

$ cd oudFrontend

3. Install dependencies

$ npm install

Running

1. Running on development mode

$ npm run json:server
$ npm run dev

2. Running on production mode

$ npm run prod

Screenshots

---

---

---

---

---

---

---

---

---

---

---

Videos

• Player

File Structure

Oud-Frontend
├── README.md
├── LICENSE
├── CONTRIBUTING.md	
└── oudfrontend	
    ├── node_modules
    ├── package.json
    ├── jsdoc.conf.json	
    ├── .env-cmdrc.json	
    ├── .gitignore
    ├── build
    ├── public
    │   ├── favicon.ico	
    │   ├── index.html
    │   └── manifest.json	
    └── src
        ├── assets
        │   ├── images
        │   └── fonts
        ├── api	
        |   ├── db.json	
        |   └── routes.json	
        ├── components	
        |   ├── Account
        |   ├── CategoryHeader	
        |   ├── likedSongs	
        |   ├── Navbar	
        |   ├── Sidebar	
        |   ├── album	
        |   ├── commonComponents	
        |   ├── MainContent	
        |   ├── Playlist	
        |   ├── Subheader	
        |   ├── Card	
        |   ├── CreatePlaylist	
        |   ├── MusicCard	
        |   ├── Profile	
        |   ├── WebPlayer	
        |   ├── CategoryBody	
        |   ├── GenreCard	
        |   ├── MusicItem
        |   └── SeeAll
        ├── config
        |   └── environment.js	
        ├── pages	
        |   ├── Account	
        |   ├── Home	
        |   ├── Profile	
        |   └── Search	
        ├── routes	
        ├── utils	
        |   └── index.js	
        ├── App.css	
        ├── App.js	
        ├── index.css	
        ├── index.js		
        └── setupTests.js

Unit testing

Each component in our project has its own unit test file separately eg. MusicCard.test.js

Running Unit tests

Run the following command.

npm run test

Generating Coverage Report

After running the following command an html version will be generated and located at coverage\index.html.

npm run test:coverage

Functional Documentation

Run the following command to generate the functional documentation report in docs/index.html

npm run docs

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Check out our contributing guidelines for ways to contribute.

Contributors

Thanks goes to these wonderful people in the frontend team.

Abdallah Hemdan💻

Abdallah Abu Sedo💻

Ahmed Walid💻

Ahmed Ashraf💻

Ahmed Mahboub💻

License

This software is licensed under MIT License, See License for more information ©AbdallahHemdan.