FamSocial

The social network for your Fam!

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Configuration
   • Running the app
3. Roadmap
4. Contributing
5. Contact

About The Project

Built With

• Bootstrap

Getting Started

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

Prerequisites

Install the latest version of Node.js (if you do not already have it)

Installation

1. Clone the repo

   git clone https://github.com/nme077/social_fam.git

2. Install NPM packages

   npm install

Configuration

1. Add .env file with the variables in .env.example

2. Connect to MongoDB - get started with MongoDB Atlas at https://docs.atlas.mongodb.com/getting-started/

• Obtain the unique URI to connect to your MongoDB database add it to your .env file.

URI="mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]"

3. Setup a Google OAuth 2.0 client - get started at https://developers.google.com/identity/protocols/oauth2

• Obtain the following credentials and add them to your .env file.

CLIENT_ID="YOUR_GOOGLE_CLIENT ID"
CLIENT_SECRET="YOUR_GOOGLE_CLIENT_SECRET"
REDIRECT_URI="http://localhost:3000/settings"
REFRESH_TOKEN="YOUR_OUATH_2.0_REFRESH_TOKEN"
CALLBACK_URL="http://localhost:3000/auth/google/callback"

4. Create a Cloudinary account to upload and access photos. Get started at https://cloudinary.com/

• Obtain the following information from your Cloudinary account and add them to your .env file.

CLOUD_NAME="YOUR_CLOUD_NAME"
API_KEY="YOUR_API_KEY"
API_SECRET="YOUR_API_SECRET"

Running the app

1. Open a terminal and run npm run build - keep this running, it will build the app whenever a change is made.

2. Open a second terminal window and run npm start

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

Contact

Nicholas Eveland - nmemusic77@gmail.com

Project Link: https://github.com/nme077/social_fam