MMcClure11 / sightings-client

SPA for users to add sightings of Flora and Fauna and leave comments. Built UI using React.js and Redux Thunk to retrieve and persist data. Implemented node-sass as a CSS precompiler to efficiently design the site.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README

Nature Watch

Overview

Nature Watch is SPA that allows users to create entries of sightings of Flora and Fauna they have seen in nature. See the backend here. This is the React-Redux front end.

Watch the demo here.

Check out the live site here.

Make sure you have the following tools installed on your system:


Github
Ruby 2.6.1
Rails 6.0.3
React 17.0.1

This is an example of what you you need to use the software and how to install them.
bundle install
rails console
rails db:create
rails db:migrate

  1. Make one folder and inside that folder clone both repos:
    git clone git@github.com:MMcClure11/sightings-client.git
    git clone git@github.com:MMcClure11/sightings-api.git
  2. cd nature-watch-api
  3. Install the gemfile packages
    bundle install
  4. Set up the Database
    rails db:create
    rails db:migrate
    optionally seed the database: rails db:seed
  5. Starting the Server (keep open while running the program)
    rails s
  6. cd into nature-watch-client
    yarn install
    yarn start
    This will open in your browser.

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

Bug reports and pull requests are welcome on GitHub at https://github.com/MMcClure11/nature-watch-api.git and https://github.com/MMcClure11/nature-watch-client.git.

Distributed under the MIT License. https://opensource.org/licenses/MIT

  • Flatiron School
  • @Jordles113

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

About

SPA for users to add sightings of Flora and Fauna and leave comments. Built UI using React.js and Redux Thunk to retrieve and persist data. Implemented node-sass as a CSS precompiler to efficiently design the site.


Languages

Language:JavaScript 57.6%Language:SCSS 21.9%Language:CSS 18.1%Language:HTML 2.4%