Diade

Compilation of international celebrations
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

Compilation of international celebrations. At this moment the project only supports spanish language.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• docker
• docker compose
• go

Installation

1. Clone the repo

   git clone https://github.com/rfdez/diade.git

2. Start the project

   docker-compose up -d

(back to top)

Usage

The API server will be running on port 8080. You can access the API celebrations endpoint at http://localhost:8080/celebrations. You can also access the API celebrations endpoint at http://localhost:8080/celebrations?date=2021-01-01.

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)