Skip to content

Latest commit

 

History

History
269 lines (199 loc) · 10.2 KB

README.md

File metadata and controls

269 lines (199 loc) · 10.2 KB
Raw

Oud Front-End

GitHub contributors GitHub issues GitHub forks GitHub stars GitHub license

Table of Contents

About The Project

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

Build with

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
  1. Navigate to repository directory
$ cd oudFrontend
  1. Install dependencies
$ npm install

Running

  1. Running on development mode
$ npm run json:server
$ npm run dev
  1. Running on production mode
$ npm run prod

Screenshots

image

25

chrome_1JjJ8yfh7A

image

image

image

62

55

52

59

102

94604376_255790072229844_6882535695697575936_n

94707053_226074958669096_6818316481399357440_n

94688968_251064116040980_741229785270714368_n 101

71

Videos

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	
    └── 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 Hemdan🎯💻👀
 Abdallah Sbu Sedo
Abdallah Abu Sedo💻
 ahmed walid
Ahmed Walid💻
Ahmed Ashraf💻
Ahmed Mahboub💻

License

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