Skip to content

A web app that allows users to search for public campgrounds filtered by state, and save campgrounds to their favorites

Notifications You must be signed in to change notification settings

nichia/campoutz

Repository files navigation

README

Campoutz

Looking for a place for your next camping trip? Explore Campoutz to find public campgrounds across the US. Signup and login to search for campgrounds by State. After login, you have the option to save campgrounds to your favorites for visiting later.

Demo

Visit https://campoutz.herokuapp.com/ to explore the campgrounds around your area. Sign up and login to save your favorites, or use this pre-made account to login:

$ Username: lorem
$ Password: password

Installation: Local

Follow the below terminal commands to start using the application. (Requirements: Ruby, Rails 5 and Node.js installed)

$ git clone git@github.com:nichia/campoutz.git
$ cd campoutz
Setup server:
  $ rvm --default use 2.6.1  <sub><sup>(*set default Ruby version 2.6.1)</sup></sub>
  $ bundle install
  $ rake db:create
  $ rake db:migrate
  $ rake db:seed
  $ cd config
  $ mv application.yml.bak application.yml  <sub><sup>(*edit the .application.yml file to fill in jwt_secret used by figaro)</sup></sub>
  $ cd ..  <sub><sup>(*move back to campoutz directory)</sup></sub>
Setup client:
  $ cd client
  $ mv .env.bak .env  <sub><sup>(*edit the .env file to fill in secret keys)</sup></sub>
  $ npm install
Start application:
  $ rake start

Usage: Local

Open up a web browser and copy/paste the IP server address into the web browser URL (usually http://localhost:3000) to use the application. Sign up and login to save your favorites, or use this pre-made account to login:

$ Username: lorem
$ Password: password

Technical Information

  • Front-end: Built using React, Redux, React Router and styled using Semantic UI components. Also integrated with google maps API components to display maps of the campgrounds.
  • Back-end: RESTful JSON API built with Ruby on Rails, using PostgreSQL database
  • External API:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nichia/campoutz.

License

The application is available as open source under the terms of the MIT License.

About

A web app that allows users to search for public campgrounds filtered by state, and save campgrounds to their favorites

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published