Appointio (back-end)

Rails back-end to this React web app.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Project details

Models

• User
• Apartments
• Types
• Appointments

ERD

Controllers

• Sessions and registrations - for creating and logging in/out users
• ... other model respective controllers

Changes made to convert vanilla rails app to API worthy

• Add rack-cors gem to configure CORS
• Add session store initializer to accept and send cookies to front-end

Tests

• Used rspec-rails for testing routes, models and controllers (as requests).
• Used shoulda-matchers to test routes and models.

Seeding database

Added seed for populating initial data to the database.

Deployed to Heroku

https://tg-appointio.herokuapp.com/

Built With

• Ruby v2.7.1
• Rails v6.0.3.3
• Postgresql 12
• Gems used:
  • Faker - seeding the database
  • Rack-CORS - allowing cross-origin resource sharing
  • Rubocop - ensuring code standards
  • Testing:
    • Database cleaner
    • RSpec-rails
    • Shoulda-matchers

Getting Started

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

Prerequisites

• Ruby v2.7.1
• Rails v6.0.3.3
• Postgresql 12

Installation

1. Clone the repo

   git clone https://github.com/tirthajyoti-ghosh/final-capstone-backend.git

2. Install Gems

   bundle install

3. Create database

   rails db:create

4. Migrate database

   rails db:migrate

5. Seed database

   rails db:seed

6. Start local server

   rails s -p 3001

7. Visit http://localhost:3001/ in your browser.

Run tests

Run this command in your terminal

rspec

Roadmap

• Implement admin panel.
• API docs

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

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

Contact

👤 Tirthajyoti Ghosh

• Website: tirthajyoti
• GitHub - @tirthajyoti-ghosh
• Twitter - @terrific_ghosh
• LinkedIn - linkedin

Project Link: https://github.com/tirthajyoti-ghosh/final-capstone-backend

Acknowledgements

• Apartment images from GettyImages
• Logo and README icon from Icons8
• Img Shields