SocialCalc Documentation
Overview
SocialCalc is a modern web application that allows for real-time collaboration on spreadsheets, similar to Excel. It offers features for live editing, user management, and collaboration.
Features
- Real-time collaboration with multiple users
- Customizable spreadsheets with various formatting options
- Sidebar with tools for saving, loading, exporting, and importing data
- Responsive design for desktop and mobile use
Getting Started
To get started with SocialCalc, follow these steps:
- Clone the Repository: Clone the SocialCalc repository from GitHub.
git clone https://github.com/Prabal-verma/SocialCalc-SIH
- Install Dependencies: Navigate to the project directory and install the necessary dependencies.
cd Socialcalc-SIH
npm install
- Run the Development Server: Start the development server.
npm run dev
- Open the Application: Open your browser and navigate to http://localhost:3000.
Using SocialCalc
Once you have SocialCalc running, you can start using it by navigating to the spreadsheet page. Here, you can:
- Edit cells and format them as needed.
- Collaborate with other users in real-time.
- Use the toolbar to undo, redo, format, and search data.
API Reference
Currently, SocialCalc does not have a public API. All interactions are handled via real-time WebSocket connections.
Troubleshooting
If you encounter issues, consider the following steps:
- Check the console for error messages.
- Ensure that your Socket.IO server is running and properly configured.
- Verify that your network settings allow WebSocket connections.
Contributing
If you'd like to contribute to SocialCalc, please follow these guidelines:
- Fork the repository and create a new branch.
- Make your changes and test them thoroughly.
- Submit a pull request with a clear description of your changes.