Getting Started
The project uses the Github API and utilizes the browser's localStorage for persistence. The following instructions will give you a copy of the project on your local machine for development and testing purposes.
Prerequisites
Make sure you have NodeJS (v9.0 or higher) and npm (v5.6.0 or higher) installed.
How to build
- Clone the repo.
- Install all dependencies using
npm install. - Start the project by running
npm start.
Prettier and Precommit Hooks
Prettier is used for automatic code formatting. It's executed on every commit using a precommit hook.
Roadmap
- Add tests
- Integrate Typescript
- Current Project page - a page with a detailed information of my current work in progress project
- Issues Page - a social page with all open issues of all my projects listed, where people can give suggestions and propose solutions
Deployment
The continuous deployment is done using Netlify.
Contributing
Pull Requests and Suggestions are highly recommended. Use the issues section to submit a suggestion or report an issue or submit a pull request.
License
This project is licensed under the MIT License - check the LICENSE for details.