OUR MISSION: An application to connect your community through reading and sharing books.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Project Description
Key Features
- User authentication
- Display the book of the month
- Explore trending books from the store
- View user libary and purchased book
- Explore user libary and
- Connect and add friends
- Create bookclub and bookclub event
- Email notification for bookclub event
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/hratx-blue-ocean/Papercuts.git
- Install NPM packages
npm install
- Enter your API in
config.js
const API_KEY = 'ENTER YOUR API';
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
See the open issues for a list of proposed features (and known issues).
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Your Name - @your_twitter - [email protected]
Project Link: https://github.com/hratx-blue-ocean/Papercuts