dyarawilliams / notebook

An app created with NodeJS, Express, MongoDB, and Google Auth 2.0

Notebook

An amazing Full-Stackapp that creates public and private stories from your life!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

![Product Name Screen Shot][product-screenshot]

There are many great notebook apps available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one.

Here's why:

• 😄

(back to top)

Built With

This section list major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few:

• NodeJS
• Express
• MongoDB

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example 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

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get Google OAuth credentials
2. Clone the repo

   git clone https://github.com/your_username_/notebook.git

3. Install NPM packages

   npm install

4. Enter your keys in config.env

   PORT = 3000
   MONGODB_URI = 
   GOOGLE_CLIENT_ID = 
   GOOGLE_CLIENT_SECRET = 

(back to top)

Usage

Add your MongoDB URI and Google OAuth credentials to the config.env file

(back to top)

Roadmap

• Add README.md
• Add back to top links in README.md

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

D'yara - @xchaoticrage - [e-mail]

Project Link: https://github.com/dyarawilliams/notebook

(back to top)