Table of Contents
This repository is them frontend for Monkey Music Group. At a high-level, The projects produces 3 apps:
- Android
- IoS
- Web
Check [package.json]](./package.json)
- Run
npm install
in root directory to install packages. - Run
npm start
to start the server. - Run either one of any of the command below in a different terminal(shell) to start the required app.
yarn run android
to start android app.yarn run ios
to start IoS app.
Follow the steps below to contribute to the project. Please ensure code is properly linted and tested. A pull request should only contain an atomic feature(a change or improvement that can not be broken down further).
- Clone the Project Repo
- Create your Feature Branch
- Commit your Changes.
- Push to the Branch
- Open a Pull Request
- To run a static(lint) test use
npm run lint
. - To format or correct most errors use
npm run format
- Use only npm.
- Use pre-existing naming convention.
- Ensure every new snippet is unique. This implies that you should check the code to ensure the feature or problem you want to solve isn't in the codebase already.
- Reduce code duplication by extracting repeated lines of code to a component. The rule of thumb is to create a component when lines of code is replicated.