README.md

Gap2Goal.app

This is a simple project management app. I developed this application to learn more about full stack javascript, using a serverless backend. It is built React, Node.js, GraphQL, MongoDB Realm, and hosted with Netlify at Gap2Goal.app
Explore the docs »

Beta Hosted Here · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

This is a simple project management app. I developed this application to learn more about full stack javascript, using a serverless backend. It is built React, Node.js, GraphQL, MongoDB Realm, and hosted with Netlify at Gap2Goal.app

Built With

• MongoDB Realm - Serverless backend and Database
• GraphQL - Server Query Language
• Node.js - Dependencies Managed with NPM and never with Yarn
• React.js - Front End Framework
• Chakra-UI - Component Library

Getting Started

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

Prerequisites

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

Installation

1. Clone the repo

   git clone https://github.com/samfitz13/Gap2Goal.app.git

2. Install NPM packages

   npm install

MongoDB Use

You'll need to create a free app using mongoDB Realm. Their documentation is very comprehensive. Once created, copy your APP-ID into the App.js File

Roadmap

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

Contributing

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @therealsamfitz - email

Project Link: https://github.com/samfitz13/Gap2Goal.app

Acknowledgements

• Coco the Dog
• Allison McBride
• Stefan Mischook