Re-former

Project description

This project is for learning purpose just to get familiar with Forms and helpers in ruby on rails. It is gotten from The Odin Project.

Tools and technologies used to build this project

1. Ruby 2.7.1
2. Ruby on Rails 6.0.3.2

Running and testing it locally

Prerequisites

1. You should have Ruby 2.7.1
2. You need to have Rails 6.0.3.2
3. You need to have Yarn v1.22.4

Setup

1. Clone this repository with git clone https://github.com/descholar-ceo/re-former

2. Go inside this repo locally by typing cd re-former

3. Run bundle install to install all ruby dependecies

4. Run yarn to install js dependencies

5. Run bin/rails db:migrate to create necessary tables in database

Testing

1. Start the server by running bin/rails server, if all of the above steps has been followed correctly, you should get a server started on https://127.0.0.1:3000 or easily https://localhost:3000
2. Go to these paths:

    GET   /users/new => Create a user 1
    GET   /users/1/edit => Edit user 1

and observe the changes in your terminal

Screenshots of the Form

Add a new user	Update existing user

Contributing

There are two ways of contributing to this project:

1. If you see something wrong or not working, please open the issue in issue section
2. If you see something to improve or to correct, and you have a solution to that, follow the below steps to contribute:
   1. Fork this repository
   2. Clone it on your local computer by running git clone https://github.com/descholar-ceo/re-former.git Replace your username with the username you use on github
   3. Open the cloned repository which appears as a folder on your local computer with your favorite code editor
   4. Create a separate branch off the master branch,
   5. Write your codes which fix the issue you found
   6. Commit and push the branch you created
   7. Open a pull request, comparing your new created branch with our original master branch here

Authors

1. MUGIRASE Emmanuel

• Github: @descholar-ceo
• Twitter: @descholar3
• LinkedIn: MUGIRASE Emmanuel

2. Witah Ngu Georjane

• Github: @Georjane
• Twitter: @WittyJany
• LinkedIn: Witah Georjane

Show your support

Give a ⭐️ if you like this project!

Acknowledgment

• Microverse
• The Odin Project