Team Papercuts

Papercuts Bookstore

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

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Papercuts is a full-stack web application for buying, browsing, and commenting on the latest books. The user can register an account and maintain their own library of books, as well as make friends, leave recommendations, and start/join book clubs!

Key Features

• User authentication
• Displays a book of the month
• Explore trending books from New York Times
• View purchased books in user library
• Search for new books in the user library
• Connect to friends
• Create Book Clubs and add Events

Application login with proper authentication

• Click Register to create a new account with the site.
• Using sessions, you will only be asked to log in again once a week, for user convenience.
• If you lose your password, you may retrieve through the forgot password button.

User Profile Page

• In your user profile, you may browse your library of purchased books or search for new ones.
• A gallery of recommended books will be available to you.
• You may also find new friends and see what they are currently recommending, as well as see the book clubs you are subscribed to.

Book Clubs Page

• On the book clubs page, you may browse the available book clubs and click to join or leave them.
• Clicking on a club's image will take you to the detailed view, where the events, comments, and questionnaire are available.
• Only the owner will be able to create events, and only logged in users will be able to comment.

Subscriptions Page

• On the subscriptions page, you may choose a plan to subscribe to. This will require you to have payment info saved in the settings page.

Built With

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.

Languages
Frameworks & Libraries
Hosting
Databases
Testing

Getting Started

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.

1. Create a free Mongo Atlas account and obtain your key.
2. Obtain a free New York Times API key.
3. Obtain a free Google Books API key.
4. Clone the repo

   git clone https://github.com/hratx-blue-ocean/Papercuts.git

5. Install NPM packages

   npm install

6. Enter your keys in the following form in a new file called .env

   MONGO_PASS=XXXXXXXX
   NYT_KEY=XXXXXXX
   GOOGLE_API_KEY=XXXXXXX

7. Start the server and access Papercuts locally at http://localhost:3000

   npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/hratx-blue-ocean/Papercuts

Acknowledgements

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License