https://github.com/viral32111/social-media
Barebones social media (Twitter) clone.
https://github.com/viral32111/social-media
full-stack-web-development social-media
Last synced: 21 days ago
JSON representation
Barebones social media (Twitter) clone.
- Host: GitHub
- URL: https://github.com/viral32111/social-media
- Owner: viral32111
- License: agpl-3.0
- Created: 2023-04-01T23:26:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T11:25:17.000Z (7 months ago)
- Last Synced: 2024-11-05T11:43:49.181Z (6 months ago)
- Topics: full-stack-web-development, social-media
- Language: TypeScript
- Homepage: https://viral32111.github.io/social-media
- Size: 769 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# Social Media
[](https://github.com/viral32111/social-media/actions/workflows/ci.yml)
[](https://github.com/viral32111/social-media/actions/workflows/codeql.yml)
This is a full-stack web application of a barebones social media platform, very similar to [Twitter](https://twitter.com).
**This project is under development! There are no stable releases and usable deployments yet.**
## 📡 Technologies
The client-side uses [Vite](https://vitejs.dev) as the toolchain, [React](https://react.dev) for constructing the user interface, [TailwindCSS](https://tailwindcss.com) & [SASS](https://sass-lang.com) for styling, [jQuery](https://jquery.com) for scripts, and [Jest](https://jestjs.io) for automated testing.
The server-side uses [Node.js](https://nodejs.org) as the runtime, [Express](https://expressjs.com) for API routes, [MongoDB](https://www.mongodb.com) for storing persistent data, [Neo4j](https://neo4j.com) for generating recommendations, and [Mocha](https://mochajs.org)/[Chai](https://www.chaijs.com) for automated testing.
Both sides use [TypeScript](https://www.typescriptlang.org) as the programming language and [ESLint](https://eslint.org) to ensure code style.
## 📥 Usage
There is a pre-built [Docker image](https://github.com/viral32111/social-media/pkgs/container/social-media) for running the server-side API, and a [GitHub Pages](https://github.com/viral32111/social-media/deployments/activity_log?environment=github-pages) deployment for viewing the client-side user interface.
The [MongoDB](https://www.mongodb.com) and [Neo4j](https://neo4j.com) databases are not bundled with the Docker image and must be setup independently.
Check the [CI workflow runs](https://github.com/viral32111/social-media/actions/workflows/ci.yml) for the latest client-side and server-side build artifacts.
## ✔️ Progress
Check the [Kanban board](https://github.com/users/viral32111/projects/10), [issues](https://github.com/viral32111/social-media/issues?q=is%3Aissue) and [milestones](https://github.com/viral32111/social-media/milestones) for tracking progress.
## ⚖️ License
Copyright (C) 2023 [viral32111](https://viral32111.com).
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.