https://github.com/kendoriddy/asosapi

This is the api for the ASOS Birthday Tracker application.
https://github.com/kendoriddy/asosapi

database postgresql rails ruby ruby-on-rails

Last synced: about 2 months ago
JSON representation

This is the api for the ASOS Birthday Tracker application.

• Host: GitHub
• URL: https://github.com/kendoriddy/asosapi
• Owner: kendoriddy
• Created: 2022-11-27T23:44:59.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-14T19:36:42.000Z (almost 2 years ago)
• Last Synced: 2024-10-19T03:38:08.428Z (3 months ago)
• Topics: database, postgresql, rails, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 43.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [Website Mockup](#screenshots)

  - [Kanban Board](#kanban-board)

  - [React Frontend](#react-frontend)

  - [API Documentation](#api-docs)

  - [🚀 Live Demo](#live-demo)

  

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 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.

- [Frontend](https://github.com/kendoriddy/asos-birthday-tracker)

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React.js

  


  Server

  


    
Rails

  


Database

  


    
PostgreSQL

  


### 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 

- [Coming soon]()

## 🚀 Live Demo 

- [Live Demo](https://asostracker.netlify.app/)

## [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 

- GitHub: [@kendoriddy](https://github.com/kendoriddy)

- Twitter: [@RideOnOne09](https://twitter.com/RideOnOne09)

- LinkedIn: [Kehinde Ridwan Onifade](https://www.linkedin.com/in/kehindeonifade)

(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 

- [Microverse](https://www.microverse.org/)

## 📝 License 

This project is [MIT](./MIT.md) licensed.

(back to top)