- About the Project
- Getting Started
- Screenshots
- Videos
- File Structure
- Unit Testing
- Functional Documentation
- Contributing
- Contributors
- License
Oud is an online music streaming service which is a mimic of Spotify with all its functionalities
This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.
- Clone the repository
$ git clone https://github.com/AbdallahHemdan/oudFrontend.git- Navigate to repository directory
$ cd oudFrontend- Install dependencies
$ npm install- Running on development mode
$ npm run json:server
$ npm run dev- Running on production mode
$ npm run prod
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
Each component in our project has its own unit test file separately eg. MusicCard.test.js
Run the following command.
npm run testAfter running the following command an html version will be generated and located at coverage\index.html.
npm run test:coverageRun the following command to generate the functional documentation report in docs/index.html
npm run docsContributions 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.
Thanks goes to these wonderful people in the frontend team.
Abdallah Hemdan🎯💻👀 |
 Abdallah Abu Sedo💻 |
 Ahmed Walid💻 |
 Ahmed Ashraf💻 |
 Ahmed Mahboub💻 |
This software is licensed under MIT License, See License for more information ©AbdallahHemdan.