/asosapi

This is the api for the ASOS Birthday Tracker application.

Primary LanguageRuby

📗 Table of Contents

📖 ASOS API

This is the backend implementation of the ASOS Birthday Tracker application. This project aims at keeping track of the date of birth of ASOS Class of 2013 and reminding the Whatsapp admins of whose birthday it is to be celebrated everyday.

🛠 Built With

Tech Stack

Client
Server
  • Rails
Database

Key Features

  • Members of Class'13 can register and Add their birthdays
  • Admin gets notified whenever it is someone's birthday
  • Users can edit their date of births

💻 Website Mockup

Entity Relationship Diagram

🚀 Live Demo

API Documentation coming soon

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Make sure you have Git and Ruby installed

 gem install rails

Install

Install the project using this command:

db Commands

rails db:create rails db:migrate rails db:seed

To generate master.key and config/credentials.yml.enc

Run in terminal:

EDITOR=code rails credentials:edit

This command will create a new master.key and credentials.yml.enc if they do not exist.

  bundle install

Usage

Run project using this command:

rails s

Run tests using this command:

rake rswag

(back to top)

👥 Author

(back to top)

🔭 Future Features

  • Rspec tests

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

⭐️ Show your support

Give a ⭐️ if you like this project!

🙏 Acknowledgments

📝 License

This project is MIT licensed.

(back to top)