- π About the Project
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgements
- π License
This repo holds the BackEnd development source for the Car Reservation App, the world's best free car reservation website. Car Reservation allows user to add car and see the car model and shop it.
Describe the tech stack and include only the relevant sections that apply to your project.
FrontEnd UI
- [Add an accommodation]
- [Make a reservation]
- Kanban Link
- Kanban Empty Screen Shot
- Final Members: 5
Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
In order to work on this project, you need to have the following dependencies installed:
Clone this repository to your desired folder:
sh git clone https://github.com/Pamphilemkp/car-reservation.git cd Budget-app
To get all the gems required for the project:
bundle install
To install packages such as style linters:
npm install
To check linters locally, use:
rubocop
npx stylelint "**/*.{css,scss}"
Once you have the project correctly set up, run:
To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes:
bin/rails db:setup
Finally, each time you make changes to the project, run
In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description:
rspec
- Check the Ruby version or if you have at all by running
ruby -v
if you get something like thisruby 2.6.8p205 (2021-07-07 revision 67951)
you have Ruby installed. - Clone the repository by running
git clone https://github.com/Pamphilemkp/car-reservation.git
in your CLI. - Type
cd Exploration-Getaways-BACKEND
- Type
code .
- Run
bundle install
- First delete `credentials.yml.enc`
- Run EDITOR="code" bundle exec rails credentials:edit
- Run
rails db:create db:migrate
- Optionally you can run
rails db:seed
to populate it - Run
rails server
to open the local server - Open Browser
http://localhost:3000/
To run the project, execute the following command:
rails server
--->
To run tests, run the following command:
sh bin/rails test test/models/article_test.rb
Open Browser and visit http://localhost:3000//api-docs/
π¨βπ» π€ Pamphile Mkp βοΈ
- GitHub: @pamphilemkp
- Twitter: @pamphilemkp
- LinkedIn: @pamphilemkp
man_technologist: π€ Basit Ali βοΈ
- GitHub: @githubhandle
- LinkedIn: LinkedIn
- Twitter: Twitter
π¨βπ» π€ Patrick Maina βοΈ
- GitHub: @PNdunguMaina
- LinkedIn: Patrick Maina
- Twitter: @ndunguwamaina_
π¨βπ» π€ Mark otuya βοΈ
- GitHub: @githubhandle
- LinkedIn: LinkedIn
- Twitter: Twitter
π¨βπ» π€ Adebowale Adegboye Monsur βοΈ
- GitHub: @githubhandle
- Twitter: @twitterhandle
- LinkedIn: LinkedIn
- [Allow user to upload avatar]
- [Include "My Profile" section/page]
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project or find it useful/interesting, please make sure you give βοΈ a since this will make it easily accesible for you too!
This work is licensed under a Creative Commons Attribution 4.0 International License.
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.
=======- π About the Project
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgements
- π License
This repo holds the BackEnd development source for the Car Reservation App, the world's best free car reservation website. Car Reservation allows user to add car and see the car model and shop it.
Describe the tech stack and include only the relevant sections that apply to your project.
FrontEnd UI
- [Add an accommodation]
- [Make a reservation]
- Kanban Link
- Kanban Empty Screen Shot
- Final Members: 5
Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
In order to work on this project, you need to have the following dependencies installed:
Clone this repository to your desired folder:
sh git clone https://github.com/Pamphilemkp/car-reservation.git cd Budget-app
To get all the gems required for the project:
bundle install
To install packages such as style linters:
npm install
To check linters locally, use:
rubocop
npx stylelint "**/*.{css,scss}"
Once you have the project correctly set up, run:
To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes:
bin/rails db:setup
Finally, each time you make changes to the project, run
In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description:
rspec
- Check the Ruby version or if you have at all by running
ruby -v
if you get something like thisruby 2.6.8p205 (2021-07-07 revision 67951)
you have Ruby installed. - Clone the repository by running
git clone https://github.com/Pamphilemkp/car-reservation.git
in your CLI. - Type
cd Exploration-Getaways-BACKEND
- Type
code .
- Run
bundle install
- First delete `credentials.yml.enc`
- Run EDITOR="code" bundle exec rails credentials:edit
- Run
rails db:create db:migrate
- Optionally you can run
rails db:seed
to populate it - Run
rails server
to open the local server - Open Browser
http://localhost:3000/
To run the project, execute the following command:
rails server
--->
To run tests, run the following command:
sh bin/rails test test/models/article_test.rb
Open Browser and visit http://localhost:3000//api-docs/
π¨βπ» π€ Pamphile Mkp βοΈ
- GitHub: @pamphilemkp
- Twitter: @pamphilemkp
- LinkedIn: @pamphilemkp
man_technologist: π€ Basit Ali βοΈ
- GitHub: @githubhandle
- LinkedIn: LinkedIn
- Twitter: Twitter
π¨βπ» π€ Patrick Maina βοΈ
- GitHub: @PNdunguMaina
- LinkedIn: Patrick Maina
- Twitter: @ndunguwamaina_
π¨βπ» π€ Mark otuya βοΈ
- GitHub: @githubhandle
- LinkedIn: LinkedIn
- Twitter: Twitter
π¨βπ» π€ Adebowale Adegboye Monsur βοΈ
- GitHub: @githubhandle
- Twitter: @twitterhandle
- LinkedIn: LinkedIn
- [Allow user to upload avatar]
- [Include "My Profile" section/page]
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project or find it useful/interesting, please make sure you give βοΈ a since this will make it easily accesible for you too!
This work is licensed under a Creative Commons Attribution 4.0 International License.
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.