daivasmara/booq-server

BOOQ - Server Side Code

BOOQ (Server-Side)

It's all about books!

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

There are MANY book platforms out there, what we're trying to do with this one is to create a better version that fits well to most Indonesian users.

This project is in building phase, and as to why we build it in open source, simply because we build this platform for community so why not jump start this one from community as well.

What we're tyring to achieve is a platform in which everyone can share, discuss, sell, and do everything revolving around books. Because we believe in "Banyak Baca Banyak Tahu".

So, From us, to us! Cheers:beers:

Built With

• Express
• GraphQL
• Mongo DB

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

npm install npm@latest -g

• MongoDB
  • Follow these steps

Installation

1. Clone the repo

git clone [email protected]:Daivasmara/booq-server.git

2. Install npm packages

npm install

3. Rename the .env-sample to .env and edit the variables to fit your own development environment
4. Start the server

npm start

Usage

This BE is built using graphql, so you can use the provided graphiql to help you see what you're looking for. localhost:<port>/graphql

The documentation is provided on the right side of the interface

Roadmap

• ERD 0.1

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

• Muhammad Daivasmara Denaw - LinkedIn - [email protected]
• Fahmi Juliansyah - LinkedIn - [email protected]
• Azis Maulana Hakim - LinkedIn - [email protected]

Project Link:

• Server : https://github.com/Daivasmara/booq-server
• Client : Coming Soon!

Deployed Link:

• Server : https://booq-server.herokuapp.com/graphql
• Client : Coming Soon!