efimeral

Efimeral

Web servers in your browser! Efimeral can create ephemeral Linux instances for free, for a short period of time.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• NodeJS v12.6.0
• Yarn v1.15.2
• Golang v1.12.7
• Docker v17.12.0-ce
• docker-compose v1.18.0

For local development, domain efimeral.com.ar and api.efimeral.com.ar must point to localhost:

# /etc/hosts
127.0.0.1 efimeral.com.ar
127.0.0.1 api.efimeral.com.ar

Installing

Each sub-project has a Makefile with default target that builds & tests the artifact (if some), builds the Docker image and pushes it into the Hub. All sub-project is chained to a main Makefile in the project's root path:

$ make

Built With

Web

• create-react-app: React application scaffolnding.
• Bootstrap: Style framework.
• Font Awesome: Nice font symbols.

API

• gin-gonic: Web framework for Golang.
• testify: Test utilities.

Docs

• API Blueprint: High level description for API.
• aglio: APIB renderer.

For all

• Nginx: Simple web server.
• CircleCI: Continuous integration service.
• Sentry: Production error tracker.

Versioning

We use SemVer for versioning.

License

This project is licensed under the GNU GPLv3 License; see the LICENSE.md file for details.