Table of Contents

• About the Project
  • Built With
• Development
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• Contact
• Acknowledgements

About The Project

Persona is a MEAN Stack Application which includes features like account creation, user authentication and profile updation.

Built With

This project would never have been possible without these wonderful frameworks.

• Node.js
• Angular CLI
• MongoDB
• Express
• Passport
• Bootstrap
• Handlebars

Development

Prerequisites

• Node.js (Download it here)
• Anguular CLI (npm install -g @angular/cli)
• MongoDB (Download it here)
• Google Developer Account (Create one here)

Startup

1. Clone the repo

git clone https://github.com/vidhi-mody/Persona-A-MEAN-Stack-Application

2. Install NPM packages

cd backend
npm install

cd angular-src
npm install

3. Create a .env file in backend folder with valid credentials as follows

GOOGLE_CLIENT_ID=<your_google_client_id>
GOOGLE_CLIENT_SECRET=<your_google_client_secret>
CALLBACK_URL=<your_google_callback_url>
MONGODB=<your_mongodb_database>

4. Start the project

cd backend
npm start

cd angular-src
ng serve -o

5. Open your terminal and run mongodb

// For MacOS
brew services start mongodb-community@4.4

6. Navigate to your browser and run

localhost:4200

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

• Vidhi Mody <@vidhi-mody, Email>

Acknowledgements

This project is a part of the Full Stack Project Task by Foreign Admits.

Project Link: https://github.com/vidhi-mody/Persona-A-MEAN-Stack-Application