https://github.com/megabytemark/titanic
https://github.com/megabytemark/titanic
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/megabytemark/titanic
- Owner: MegaByteMark
- License: mit
- Created: 2024-11-10T15:53:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-14T14:06:28.000Z (over 1 year ago)
- Last Synced: 2025-09-13T09:07:59.134Z (9 months ago)
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# titanic
Cross platform synchronisation API written in Go to provide a lightweight relational and non-relational database sync layer.
# Server Side Sync Component
Why is it called Titanic?
Because it ~~sinks~~ syncs.
Titanic is an offline database sync framework. The framework is designed to support offline synchronisation across multiple platforms, including Windows, Linux, macOS, Android, iOS, and web.
## Features
- **Cross Platform**: Designed to work with any platform, if it can run Node.js, it can run Titanic.
- **Database Agnostic**: Designed to work with all mainstream database engines, relational and document.
## Getting Started
Todo - environment variables
Todo - ValKey setup
Todo - getting started with Database Engines on Docker.
### Prerequisites
Before you begin, ensure you have Node.js and npm installed on your system.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/MegaByteMark/Titanic.git
cd Titanic
```
2. Install dependencies: npm install
3. Start the server: npm start
## API Endpoints
| Method | Endpoint | Description |
|--------|---------------|---------------------------|
| GET | /api/status | Check server status |
| POST | /api/sync | Sync data with the server |
## Database Support
| Sql Server | Postgre Sql | Oracle | MySql | MariaDb | SQLite | MongoDb |
| --- | --- | --- | --- | --- | --- | --- |
| In progress | Todo | Todo | Todo | Todo | Todo | Todo |
## Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or suggestions.
## License
This project is licensed under the MIT License. See the LICENSE file for details.