y-67 / campy-frontend Goto Github PK

The AirBnB of Camping!
Explore the docs »
View Demo

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing

• Contact
• Developers

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, email

• React.js
• PostgreSQL
• Python / Flask-RESTX
• Google API
• Firebase Storage
• Material-UI

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

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

1. Create a root project folder named campy

mkdir campy

2. Clone the front-end repo

git clone https://github.com/arsentieva/campy-frontend.git

3. Install NPM packages for the front-end repo

npm install

4. Clone the back-end repo as a sibling to the front-end (within the /campy folder)

git clone https://github.com/arsentieva/campy-backend.git

5. Enter pipenv shell and install pipenv packages

pipenv shell
# and then...
pipenv install

Visitors can Explore existing locations without logging in or signing up and view available Menu options under the Hamburger Icon (Yum!).

The Explore feature allows visitors to view existing hosted locations through our map powered by Google API.

Visitors can select a location to view its details and the amenities the host has designated as available.

For more the more personalized features will require the user Login or Sign Up with their credentials or the provided Demo User button.

Users who are signed in can view and edit their accounts within the My Account page, accessible from the Menu Navigation Sidebar.

Book a stay using the Calendar! Or host a location of your own that other users can schedule a time to visit using the Host a location button.

Happy Camping!

See the open issues for a list of proposed features (and known issues).

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

Project Link: https://github.com/arsentieva/campy-frontend

• Aaron Bruce
• Anna
• Arom Jhee
• Kristen