README.md

Memories

A social network where you can share your best photos!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Frontend
   • Backend
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

The App is called "Memories" and it is a simple social media app that allows users to post interesting events that happened in their lives. It is a full-stack application using React, Node.js, Express & MongoDB.

Project done thanks to Javascript Mastery.

(back to top)

Built With

Frontend

React
React Router
Redux
Material UI
React Google Login
Axios
jwt-decode
Moment
Dotenv

Backend

Node
Express
Nodemon
MongoDB
Mongoose
Dotenv

(back to top)

Getting Started

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/gobwah/memories_fullstack_app.git

2. Open console in /server
3. Install Sanity

   npm install

4. Taking .env.example file as an example, create a .env file at the root of /server to store your backend settings. Please check MongoDB docs if necessary.

   PORT = 5000
   CONNECTION_URL = mongodb+srv://<username>:<password>@cluster0.lguc4.mongodb.net/<database_name>?retryWrites=true&w=majority
   JWT_SECRET = ANYTHING

5. Open console in /client
6. Install dependencies

   npm install

7. Taking .env.example file as an example, create a .env file at the root of /client to store your backend URL and Google Console API credentials. Please check Google docs if necessary.

   REACT_APP_GOOGLE_CLIENT_ID = 864684-eddede-tgg
   REACT_APP_GOOGLE_CLIENT_SECRET = FRFZ88-frfr45fr5
   REACT_APP_SERVER_URL = http://localhost:5000 (as default)

(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

Vincent DELLA-LIBERA - @vincent-dellalibera - vincent.dellalibera@gmail.com

Project Link: https://github.com/gobwah/memories_fullstack_app

(back to top)

Acknowledgments

• @adrianhajdin (JS Mastery)

(back to top)