thebinaryfelix / galaxies-api-demo

Demo API for showing how to write a simple documentation and principles of project organization

🌌 Galaxies API

Intro

This is a demo API, created for educational purposes. The main use of this code is to orient Ironhack's students with their second project on the Web Development Course.

📝 Description

This project consists on a base code for constructing a REST API that provides minimal data about known galaxies in the universe.

Objectives

• Show a demo API using a simple server setup with Express.js
• Document its routes and params in Swagger
• Create a basic project structure for designing APIs with Javascript

🚀 Run the project

⚠️ Requirement

• You should have MongoDB Community Edition ^4.2 running on your machine

Steps

1. Download or clone this repo
2. Run npm install to download project dependencies
3. Run npm start
4. Project will run on http://localhost:3000 by default
5. To populate database, run npm run seed.

To open the endpoint docs access: http://localhost:3000/api-docs

🔨 Setup environment

You must create a .env file in the root folder and setup the following variables

• PORT = number_of_port [default=3000]
• ENV = [development || production]
• DATABASE_URL = mongodb_database_url

Final considerations

• This project:
  • is adept to the Karma conventions for commit messages
  • uses express-swagger-generator to document API endpoints

🎉 If you like this project, give it a star 🌟