RitwikDiv/makepals

MakePals app allows you to make friends online by creating discord chats on demand based on what you want to do!

MakePals

MakePals app allows you to make friends online by creating discord chats on demand based on what you want to do!
View Project · Report Bug

Table of Contents

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

About The Project

MakePals hopes to create a community for people through shared interests.

• Do you want to talk to people who watching same tv shows as you? Create a discord room using MakePals api and just wait for people to roll in!
• Do you want to find people to play Among Us or other multiplayer games with you? Create a room and join in!

What ever it is you want to talk to people about, create a room and simply join!

Built With

• Frontend: Vue.JS, Bootstrap
• Backend: Node.JS, Express.JS, Mongoose, Discord.JS

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/RitwikDiv/makepals

2. Install NPM packages

   npm i
   cd backend
   npm i 
   cd ..

3. Run the application

   npm run begin

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

Ritwik Divakaruni - @ritwikdiv