Free day

Free day is a free software project that aims to create a microservice with which to know the holidays of different parts of the world.

Objective

We will build a REST API to make easier to know if it's holidays in any part of the world. The idea is that anyone can post the holidays day their country, state or city.

Why this project?

I've been thinking and looking around and there's nothing like Free day. Let's say you are building a service that needs to know if it's holiday on the country that it's running for some purpose. You don't need to hardcode the holidays, just use an API and get the holidays of any part of the world: country, state or city. And the fact that anyone can contribute makes. Very usefull for the interational commerce. Free day unique and with a great growing potential.

How it works?

The main goal of this project is that you can easily get the holidays from a city, country or state. If you want to know the vacations of a specific city, upon request to the API you will be informed of the holidays of both the city and the state to which the city belongs and to the country of the city. In this way with a single query you can get all the holidays that affect a city.

Docker Hub

Check our image on docker hub: https://hub.docker.com/r/conacious/freeday

Install

To install this project in your server and run it you just have to follow this steps

You can also run FreeDay in Docker containers! More info here

Deploy

Kubernetes Deployment on Azure

For deploying our project we choosed Azure because it gives you 100$ of free credits if you have a proper student license. We choosed to deploy our app on a Kubernetes cluster, the full process and explanation here

Deployment on Azure from github with CI

Azure is a great solution for fast and stable deployments. For small projects you can also benefit from it's free tiers. Check here to follow the whole process.

Deployment on Heroku from github with CI

Heroku offers a free way to easy and fast deploy your app to the cloud! With the heroku things are made easy, check here to depoy on Heroku.

Deployment Docker containers to Azure

Kubernetes it's a great solution but too complex and expensive for our project. So we decided to deploy our dockerized project to an Azure VM. You can see the whole process here

Deployment Docker containers to Heroku

The easiest way and the fastest method to deploy the project it's with Heroku. But it's not a real solution for real production projects. But a good way to test projects in the cloud. Check here how to deploy on Heroku!

Vagrant and Ansible

We choosed vagrant for creating and managing the VM that will host our project. Ansible will be responsible for provisioning the necessary to the virtual machine. Check the whole process here from creating the VM to uploading to vagrant cloud through provisioning with ansible.

provision: vagrant-ansible/provisioning/playbook.yml

Build

buildtool: package.json

Build tool documentation can be found here

APi Design

Check your API endpoints here. and user stories here.

Test Framework

Check the test framework and library used for testing here.

Tool belt

You can check the tools here

Logging system

To handle the logs of the different containers of the application, we have chosen the EFK stack (Elasticsearch, Fluentd and Kibana). If you want to know how to view the logs with Kibana, click_here

Usage example

Coming soon.

Development setup

To set up a development envirorment and contribute you just have to follow the Install steps.

Release History

• 0.1
  • Description of the project.
• 0.2
  • Description of the choosen framework and tools.
• 0.3
  • First API Development and Tests developed functionalities.
• 0.4
  • Completed Documentation.
• 0.5
  • Completed API Rest, Dockerized App, Completed Endpoints Tests
• 0.6
  • Added pm2 and proper build tool configuration, modified some endpoints
• 0.7
  • Deployment on Azure and Heroku
• 0.8
  • Deployment on Azure and Heroku with Docker
• 0.9
  • Vagrant and Ansible added to project

Meta

Víctor Moreno Jiménez – [email protected]

Distributed under the GNU General Public License v3.0 license. See LICENSE for more information.

https://github.com/VictorMorenoJimenez/github-link

Contributing

1. Fork it (https://github.com/VictorMorenoJimenez/IV/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request