Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.07 KB

README.md

File metadata and controls

76 lines (57 loc) · 2.07 KB
Raw

Logo of the project

Artemis Server

A GraphQL-enabled server seed

The Artemis Server is a server seed for many of my upcoming projects, it allows a developer to expose a GraphQL interface to the client, significantly improving server performance.

Installing / Getting started

To get started with the Artemis Server:

git clone https://github.com/aarohmankad/artemis-server.git
mv artemis-server/ [project_name]/
cd [project_name]/
...
remove built in origin
add origin of your project
change names in package.json
update README.md
...
yarn start

Developing

Built With

apollo-server-express: GraphQL integration with express bcrypt: hashing and comparing user passwords dataloader: batching separate requests for same model type jsonwebtoken: assigning login tokens to users on sign in merge-graphql-schemas: allowing modularization of type definitions and resolvers subscription-transport-ws: enabling live updates between client/server through websockets.

Prerequisites

Node.js, nvm (preferred) Yarn (preferred) nodemon (for development)

Contributing

git clone https://github.com/aarohmankad/artemis-server.git
cd artemis-server/
yarn install
nodemon

Configurations

There must be a root-level config/ folder.

As of now, the necessary files are:

jwt.js

module.exports = {
  SECRET_KEY: "any sort of string here, try to make it difficult to crack",
  TESTING_TOKEN: "create and log a user in, use the token returned here",
};

mongo.js

module.exports = {
  URL: "mongodb://localhost:27017/[project_name]",
};

Licensing

This project is licensed under the MIT License. The MIT License is:

A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

For more information about the MIT License: tl;drLegal