Oud Front-End
Table of Contents
- About the Project
- Getting Started
- Screenshots
- Videos
- File Structure
- Unit Testing
- Functional Documentation
- Contributing
- Contributors
- License
About The Project
Oud is an online music streaming service which is a high quality clone 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
- Clone the repository
$ git clone https://github.com/AbdallahHemdan/oudFrontend.git
- Navigate to repository directory
$ cd oudFrontend
- Install dependencies
$ npm install
Running
- Running on development mode
$ npm run json:server
$ npm run dev
- Running on production mode
$ npm run prod
Screenshots
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 Abu Sedo |
 Ahmed Walid |
 Ahmed Ashraf |
 Ahmed Mahboub |
License
This software is licensed under MIT License, See License for more information ©AbdallahHemdan.
3 Sep 3, 2022
18 Aug 9, 2022
1 Apr 16, 2022
10 Dec 23, 2022
36 Dec 19, 2022
2.2k Dec 17, 2022
3 Feb 11, 2022
580 Jan 7, 2023
1 Nov 14, 2022
![[ImgBot] Optimize images](https://avatars.githubusercontent.com/in/4706?v=4)
10 Sep 5, 2022
82 Dec 3, 2022
11 Jul 11, 2022
3 Jan 3, 2022
20 Mar 29, 2022
483 Jan 3, 2023
0 Dec 28, 2021
101 Nov 19, 2022
1 May 24, 2022
52 Aug 19, 2022