README.md

SOM serverless Graphql API

Guideline and examples for SOM serverless Graphql , encouraging consistency, maintainability, and best practices across applications.

Prerequisites

• Download and install NodeJS
• Download and install Yarn
• Download and install MongoDB
• Download and install Code editor that you prefer

Running Locally

All Serverless setup you find here

Before start, install the serverless using the yarn:

yarn global add serverless

Or via npm

nom i -g serverless

First clone the project:

git clone [email protected]:midianinja/som-api.git

Or via https:

git clone https://github.com/midianinja/som-api.git

Go to the project root folder:

cd som-api

In root directory install the dependecies:

yarn

or via npm

npm i

Run the mongoDB:

sudo service mongod start

Start the server locally:

yarn dev

or you can run using IP and port

yarn dev --host 192.168.0.1 --port 3000

The default port is 3000

Running the tests

[...]

Deployment

[...]

Built With

• Serverless - Component library
• GraphQL - The api schema
• Apollo GraphQL - Used Apollo Server
• Yarn - Dependency Management
• ESLint - Source analyze Tool. Airbnb JavaScript Style Guide
• JSDOC - JavaScript Documentation

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.