Git Product home page Git Product logo

sightings-api's Introduction

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. View the frontend here. This is the Rails API backend which handles data persistance with PostgreSQL.

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

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 [email protected]:MMcClure11/sightings-client.git
    git clone [email protected]: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/sightings-api.git and https://github.com/MMcClure11/sightings-client.git.

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

  • Flatiron School
  • @Jordles113

sightings-api's People

Contributors

mmcclure11 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.