Rails Engine

About This Project

Rails Engine FE is a Django Application that consumes several endpoints rendered by Rails Engine Repository. The purpose of this project is to demonstrate Service Oriented Architecture where font-end and back-end team chose to build their applications using different programming languages.

(back to top)

Features Implemented:

• Consume the following V1 Endpoints to render data to user:
  • All merchants with merchant names as links to their show page:
    • Backend endpoint:GET http://localhost:3000/api/v1/merchants
    • Frontend url(root): http://127.0.0.1:8000/
    
  • One merchant with items of thtat merchant with item names as links to item show page:
    • Backend endpoint:GET http://localhost:3000/api/v1/merchants/{{merchant_id}}
    • Frontend url: http://127.0.0.1:8000/{{merchant_id}}
    
  • All items with item names as links to the item show page:
    • Backend endpoint: GET http://localhost:3000/api/v1/items
    • Frontend url: http://127.0.0.1:8000/items
    
  • Items show page with item details:
    • Backend endpoint: GET http://localhost:3000/api/v1/items/{{item_id}
    • Frontend url: http://127.0.0.1:8000/items/{{item_id}}
    
  • Search Mercants by name via search bar on home page:
    • Backend endpoint: GET http://localhost:3000/api/v1/merchants/find?name=iLl
    • Frontend url(landing page): http://127.0.0.1:8000/](http://127.0.0.1:8000/search?...search=group
    
  • Edge case handled in search merchants by name: no user input for search:

(back to top)

Installation

As neither the front-end or the back-end service is held on a public server, please follow the following instructions to start both front-end/back-end servers to navigate the urls and run tests.

Pre-requiste: Clone the backend Rails Engine Repo and start server:

1. Fork and/or Clone the BE repo

git clone git@github.com:kg-byte/viewing_party.git

2. Install gems and dependencies

 bundle install

3. Set up db/seed file with the following content:

cmd = "pg_restore --verbose --clean --no-acl --no-owner -h localhost -U $(whoami) -d rails-engine_development db/data/rails-engine-development.pgdump"
puts "Loading PostgreSQL Data dump into local database with command:"
puts cmd
system(cmd)

4. Run the following line and you may see lots of output including some warnings/errors from pg_restore that you can ignore.

 db:{drop,create,migrate,seed}

5. Run the following line - Check to see that your schema.rb exists and has the proper tables/attributes that match the data

rails db:schema:dump

7. Run run test suit

bundle exec rspec

8. Start the server to service API requests:

rails s

(back to top)

Clone and set up Rails Engine FE (this repo):

1. Fork and/or Clone this repo

git clone git@github.com:kg-byte/rails_engine_fe.git

2. Set up and activate a virtual environment in the repository directory:

python3 -m venv my_env
source my_env/bin/activate

3. Install the django, requests and any other required modules:

pip install django
pip3 install requests

4. Start the server:

python manage.py runserver

5. Run tests:

python ./manage.py test

6. Visit the front-end urls mentioned above in features implemented, e.g., the homepage(merchannt index page):

http://127.0.0.1:8000/

(back to top)

Built With

• Django Framework

(back to top)

Versions

• Python 3.9.13

(back to top)

Contributors

• Author: Kim Guo

• Author: Kim Guo

(back to top)