Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 3.33 KB

README.md

File metadata and controls

49 lines (31 loc) · 3.33 KB

Social Media

CI CodeQL GitHub tag (with filter) GitHub repository size GitHub release downloads GitHub commit activity

This is a full-stack web application of a barebones social media platform, very similar to Twitter.

This project is under development! There are no stable releases and usable deployments yet.

📡 Technologies

The client-side uses Vite as the toolchain, React for constructing the user interface, TailwindCSS & SASS for styling, jQuery for scripts, and Jest for automated testing.

The server-side uses Node.js as the runtime, Express for API routes, MongoDB for storing persistent data, Neo4j for generating recommendations, and Mocha/Chai for automated testing.

Both sides use TypeScript as the programming language and ESLint to ensure code style.

📥 Usage

There is a pre-built Docker image for running the server-side API, and a GitHub Pages deployment for viewing the client-side user interface.

The MongoDB and Neo4j databases are not bundled with the Docker image and must be setup independently.

Check the CI workflow runs for the latest client-side and server-side build artifacts.

✔️ Progress

Check the Kanban board, issues and milestones for tracking progress.

⚖️ License

Copyright (C) 2023 viral32111.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses.