https://github.com/pimp-my-book/pmb-plus-backend
The backend API for PMB Plus. A marketplace for second hand textbooks. 🛒
https://github.com/pimp-my-book/pmb-plus-backend
Last synced: about 2 months ago
JSON representation
The backend API for PMB Plus. A marketplace for second hand textbooks. 🛒
- Host: GitHub
- URL: https://github.com/pimp-my-book/pmb-plus-backend
- Owner: pimp-my-book
- License: mit
- Created: 2019-08-05T11:58:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T09:11:48.000Z (over 2 years ago)
- Last Synced: 2025-02-11T09:50:41.358Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.02 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PMB Plus Backend
This is the backend for PMB Plus
It is powered by [`Apollo-Server-Lambda`](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-lambda) and uses the [Serverless Framework](https://serverless.com/) to deploy it to AWS.
(Dev URL)[https://8147miop87.execute-api.us-east-1.amazonaws.com/dev/graphql]
## Prerequistes
- [An AWS Account](https://aws.amazon.com/)
- [A configured AWS CLI](https://serverless.com/framework/docs/providers/aws/guide/credentials/)
- [Serverless Framework installed on your machine](https://serverless.com/framework/docs/providers/aws/guide/installation/)
- [NodeJS](nodejs.org)
Note this project uses [Yarn](https://yarnpkg.com).
## How to get started
First clone the repo:
```
$ git clone https://github.com/pimp-my-book/pmb-plus-backend
```
Move into the project folder:
```
$ cd project-name
```
Then Install all its dependancies:
```
$ yarn install
```
Then you should be able to invoke the Lambda locally:
```
$ yarn offline
```
To deploy to AWS run the following command:
```
$ yarn deploy
```
This should be a good start to be able to move on and do whatever you gotta do meet business requirements.