TopicSphere is a platform designed to manage and explore topics of interest, featuring both a backend service and a frontend interface. The project leverages the functionality of two repositories to provide a complete solution for topic management:
The repository is organized into two primary components:
LIREDDIT-SERVER
: Contains the backend code, including API endpoints and data management logic.lireddit-web
: Contains the frontend code, providing the user interface and interaction with the backend services.
- API Endpoints: Handles CRUD operations for topics.
- Data Management: Manages storage and retrieval of topic-related data.
- User Authentication: Supports user registration and login.
- Real-Time Updates: Provides real-time updates to the frontend.
- Dynamic User Interface: Interactive UI for exploring and managing topics.
- Real-Time Data Display: Updates reflect changes from the backend instantly.
- Responsive Design: Accessible and functional across various devices and screen sizes.
-
Clone the repository:
git clone https://github.com/mdafraz/SocialNexus-server.git
-
Navigate to the backend directory:
cd SocialNexus-server
-
Install dependencies:
npm install
-
Create a
.env
file in the root directory and add necessary environment variables (refer to.env.example
for required variables). -
Start the backend server:
npm start
-
Clone the repository:
git clone https://github.com/mdafraz/SocialNexus-web.git
-
Navigate to the frontend directory:
cd SocialNexus-web
-
Install dependencies:
npm install
-
Start the frontend application:
npm start
Once both the backend and frontend are running, access the application:
- Frontend: http://localhost:3000
- Backend API: http://localhost:5000
The project is currently in development. The following features are implemented:
- Backend services for managing topics and user authentication.
- Frontend interface for interacting with the backend and displaying topic data.
- Backend: Improved API functionality, additional endpoints, and more robust error handling.
- Frontend: Enhanced user interface features, improved responsiveness, and more interactive elements.
To contribute to TopicSphere:
- Fork the repository.
- Create a new branch:
git checkout -b my-feature
. - Make your changes and commit them:
git commit -am 'Add new feature'
. - Push to the branch:
git push origin my-feature
. - Create a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
For any questions or suggestions, please reach out:
- Name: Abdul Nishar
- GitHub: abdul-nishar
- Email: ([email protected])