Bookify

Book platform app for authors who can publish books and readers who can buy and read

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This is a Book app with authors and users where authors can post their books and users can buy them. Built with EXPRESS RESTful API on the backend and Angular on the front end.

Built With

• Express
• Angular

Getting Started

If you want to run the app you should follow the steps below!

Prerequisites

You need to have Node Package Manager (npm) installed and configured.

Installation

1. Clone the repo

git clone https://github.com/dimitur2204/Bookify.git

2. Install NPM packages

npm install

3. Create a '.env' file in the config folder and enter your MongoDB Atlas Data in it: You will need

DB_PASS=example_password

DB_NAME=example_db_name

DB_USERNAME=example_username

DB_CLUSTER_NAME=example_cluster_name

Otherwise if you want to run it locally
you should have Mongo shell installed and change the database connection
string in dev.config.js to your localhost database

4.When you are in the base directory run npm start. Then go to localhost://3001 or the port you have configured and make all the request you want.

Usage

To view the documentation you should start the local server first and then head to http://localhost:3001/api/v1/docs

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 Apache License 2.0. See LICENSE for more information.

Contact

Dimitar Nizamov - dimitur2204@gmail.com

Project Link: https://github.com/dimitur2204/Bookify

Acknowledgements

No one to acknowledge yet!