Skip to content

Latest commit

 

History

History
136 lines (84 loc) · 3.6 KB

README.md

File metadata and controls

136 lines (84 loc) · 3.6 KB
Raw

Nexus 🚀

Nexus is an open-source chatting app inspired by Discord, designed to provide a modern, feature-rich, and community-driven communication platform. It is built with HTML, JavaScript, CSS, and Node.js.

Features ✨

  • Real-time chat functionality 💬
  • Support for text messages 📝
  • User registration and authentication system 🔐
  • Direct messaging between users 📩
  • User profiles with avatars and banners 🙋‍♂️🖼️
  • Emojis and reactions (Coming Soon) 😄👍
  • Wide variety of different Themes 🌈
  • ...

Changelogs 🪵

Find the changelog here: https://github.com/NoErrorStudio/Nexus/blob/main/CHANGELOG.md

Prerequisites 📋

Before running Nexus locally, make sure you have the following:

  • Node.js (18.x) installed on your machine.

Getting Started 🚀

Follow these easy steps to quickly set up your own Nexus instance/server.

1. Clone the repository:

git clone https://github.com/NoErrorStudio/Nexus.git

2. Install dependencies:

cd Nexus
npm install

3. Configure the application:

In the .env.example file change all variables to whatever you want and change the filename to .env.

4. Start the server:

npm start

Open your browser and visit http://localhost:3000 to access Nexus.

Public Hosting (Coming Soon) 🌐

We are working on providing easy deployment options for Nexus on public hosting platforms such as Replit. Stay tuned for updates!

Contributing 🤝

Feel free to make Pull Requests with new features, fixes or improvements. Follow the underneath steps to do so:

  • Fork this repository
  • Create a new branch:
    • New Feature: git checkout -b feature/<your-feature>
    • Fix: git checkout -b fix/<your-fix>
    • Improvement: git checkout -b improvement/<your-improvement>
  • Add your new necessary files: git add .
  • Commit your changes: git commit -m "<commit message>"
  • Push the changes to your branch: git push origin <branch>/<your-branch-name>
  • Submit a Pull Request

Goals for Nexus ⭐🍴

Our goals for Nexus are:

  • Reach 100 stars ⭐
  • Reach 50 forks 🍴

Help us achieve these goals by giving Nexus a star and sharing it with others!

Authors 👨‍💻

Nexus is developed by Gaurav, Vikas Jha, jvherck and Ninju from NoError Studios.

License 📄

Nexus is licensed under the MIT License.

Acknowledgements 🙏

We would like to express our gratitude to the following open-source projects and resources that helped make Nexus possible:

  • Socket.io 🌐
  • Express.js 🚂
  • MongoDB 📝
  • Nodemailer 📨

Contact 📧

For any questions or inquiries, please reach out to our team at contact@noerror.studio

Hiring and Custom Development 💼

Looking for customized features or interested in hiring our team for a custom version of Nexus? Or maybe a greater project? Visit NoError Studios or contact us via GitHub for more information.

Sponsorship 💖

Consider sponsoring the Nexus project to support its ongoing development and maintenance. Your sponsorship helps us dedicate more time and resources to improving the app and adding new features. You can sponsor the project by clicking the "Sponsor" button on our GitHub repository.

Enjoy chatting with Nexus! 😃