/afrikaan-restaurant-api

This is an API for Afrikaan Restaurant Food Ordering App hosted at https://afrikaan-restaurant-client.vercel.app/

Primary LanguageRubyOtherNOASSERTION

Afrikaan Restaurant API

Author Name:

Andrew Omondi Ochieng

Project Name:

Afrikaan Restaurant

Description of the program:

The program is a food ordering application where one can order food from one of the major cities in kenya. The user has the ability to choose a specific restaurant on which to order a particular food item(s) from the menu.

Technology Used

  • Ruby on Rails
  • Ruby
  • Railway Hosting

Setup Requirements

- Git (to clone the repository)
- Ruby 2.7.4
- Rails 7.0.4
- PostgreSQL (to run the database)
- Postman (to test the API)
- Railway cli (if you want to deploy to Railway)

Setup Installation

- Clone the repository
- Run the following commands in the repository:
    - cd <path_to_project> (if you cloned the repository)
    - run bundle install to install the gems
    - run rails db:migrate db:seed to start off the migrations and 
- Open Postman to test the API endpoints or use the following link:
    - http://localhost:3000/<the_endpoint>
- Run the following commands if you want to deploy to Railway:
    - railway login
    - railway init
    - railway add
    - railway up

Endpoints

POST

/user/create/

  • Create a new user
{
  "username": "string",
  "email": "user@example.com",
  "address": "Lavington"
  "password": "string"
}
  • Response:
{
  "success": "User created successfully"
}

Future Additions

  • Add a reviews section where clients can leave their ratings & comments
  • Add payment intergrations where after checking out, clients can make direct payments
  • Add more locations(towns) to the platform in that people in other areas can also benefit from the application.

GitHub Pages:

Afrikaan Restaurant API

Afrikaan Restaurant Client


Contact

email: andrewomosh44@gmail.com

LinkedIn | Twitter | Github


Known Bugs

So far so good there are no bugs related to this project 😎

Support and contact details 😃

To make a contribution to the code used or any suggestions you can click on the contact link and email me your suggestions.


License information

MIT

Copyright (c) 2022 Andrew Ochieng