SociAlly

At SociAlly, we empower individuals to come together and collaborate on a common goal.
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

At SociAlly, we empower individuals to come together and collaborate on a common goal. We were founded in January 2024 with the aim of nourishing a culture of dedication, respect and a will to create lasting impact through voluntary NGO participation. Our organization's main objective is to provide all users an easy intermediary interface to access all activities conducted by reputed NGO's within their regions and encourage them to take part in the aforementioned activities. We believe that at the heart of every user there's a drive to create positive change, and bring about goodwill, hence we strive to bridge the gap between all users and NGO's, benefitting both- the eager volunteers and the hardworking organizations who welcome the support.

(Back To Top)

Built With

• Node.js
• HTML
• CSS
• JS
• Express
• MongoDB

(Back To Top)

Getting Started

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

Prerequisites

node.js and npm should be installed.

• node

  node -v
  npm -v

Installation

1. Clone the repo

   git clone https://github.com/Aaryan-Urunkar/SociAlly.git

2. Install needed packages

   npm install

3. Enter .env variables

   Atuh0:- SECRET, BASEURL, CLIENTID, ISSUER
   MongoDB:- MONGOPASS
   Gemini bot:- API_KEY

4. Run server

   npm start

(Back To Top)

Usage

Website Link

(Back To Top)

Roadmap

• Transition to nodejs/express
• Auto API updates to get new NGO activites by collaborating with NGO's
• Full account authentication
• Reward System and Leaderboard to work.

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

(Back To Top)

Contributing

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".

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

Varun Jhaveri
Aaryan Urunkar
Oren Coelho
Aaryan Mantri
Project Link: https://github.com/Aaryan-Urunkar/SociAlly

(Back To Top)