README.md

Star wars

Description

The star-wars-server is an apollo-graphql server that wrap the Star Wars API.

It is live on Netlify. This API server is hosted on Heroku.The UI repo is found on Github

Table of Contents

• Technology Stack
• Installation
• Testing

Technology Stack

• TypeScript, NodeJs, express, apollo-graphql - core platform and development tools
• Jest - for unit and integration testing.

Installation

1. Install v12.16.2 Node JS.
2. To clone, run git clone https://github.com/cosmas28/star-wars-server.git.
3. cd into the root of the project directory.
4. Install yarn.
5. Run yarn on the terminal to install dependecies.
6. Create a .env file in the root directory of the application. Example of the content of a .env file is shown in the .env.example
7. To start the application run yarn dev.

Testing

Unit tests - Run yarn test on the terminal while within the project root directory.