mirror of
https://github.com/ragestudio/comty.git
synced 2025-06-09 10:34:17 +00:00
Updated Readme
This commit is contained in:
parent
3adfd9f149
commit
d44418515c
18
README.md
18
README.md
@ -5,14 +5,13 @@
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
# Comty - A prototype of a social network
|
# Comty - A prototype of a social network
|
||||||

|
|
||||||
[](https://www.codefactor.io/repository/github/ragestudio/comty)
|
[](https://www.codefactor.io/repository/github/ragestudio/comty)
|
||||||
[](https://codeclimate.com/github/srgooglo/comty/maintainability)
|
[](https://codeclimate.com/github/srgooglo/comty/maintainability)
|
||||||
[](https://discord.gg/yxQR6EXf2F)
|
[](https://discord.gg/yxQR6EXf2F)
|
||||||
|
|
||||||
A prototype of a platform inside of application focused on services and creatives.
|
The platform to hold all your creative.
|
||||||
|
|
||||||
> 👋 We have a open alpha preview version of the project, you can access it from [https://comty.app](https://comty.app)
|
> 👋 We have a official beta instance, you can access it from [https://comty.app](https://comty.app)
|
||||||
|
|
||||||
## 🌟 Some of features
|
## 🌟 Some of features
|
||||||
🚀 Real-time updates are provided to users about various activities such as new followers, likes, posts, comments, and more, thanks to a bid event engine that uses websockets.
|
🚀 Real-time updates are provided to users about various activities such as new followers, likes, posts, comments, and more, thanks to a bid event engine that uses websockets.
|
||||||
@ -44,11 +43,11 @@ We have official public services that you can find on these platforms!
|
|||||||
### Prerequisites
|
### Prerequisites
|
||||||
For local development you will need to have installed some tools:
|
For local development you will need to have installed some tools:
|
||||||
|
|
||||||
- Install Node.js (v13 or higher) [manualy](https://nodejs.org/en/download/) or use [nvm](https://github.com/nvm-sh/nvm) tool (Recommended)
|
- Install Node.js (v18 or higher) [manualy](https://nodejs.org/en/download/) or use [nvm](https://github.com/nvm-sh/nvm) tool.
|
||||||
|
|
||||||
- Install [Yarn](https://yarnpkg.com/getting-started/install) package manager (Recommended)
|
- (Optional) Install [Yarn](https://yarnpkg.com/getting-started/install) package manager.
|
||||||
|
|
||||||
- Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment
|
- (Optional) Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment.
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
- Getting the repository
|
- Getting the repository
|
||||||
@ -74,4 +73,9 @@ yarn
|
|||||||
Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the CONTRIBUTING.md file.
|
Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the CONTRIBUTING.md file.
|
||||||
|
|
||||||
## License 📜
|
## License 📜
|
||||||
Comty is licensed under the LGPL-2.1 license. See the LICENSE file for more details.
|
Comty is licensed under the Comty license. See the LICENSE file for more details.
|
||||||
|
|
||||||
|
## :heart: Thanks to our supporters
|
||||||
|
<kbd><img src="https://avatars.githubusercontent.com/u/94137617?v=4" href="https://github.com/SoyRage" height="64" width="64" border="1px" align="center"></kbd>
|
||||||
|
<kbd><img src="https://avatars.githubusercontent.com/u/84641340?v=4" href="https://github.com/FoxasFoxVulpes" height="64" width="64" border="1px" align="center"></kbd>
|
||||||
|
<kbd><img src="https://avatars.githubusercontent.com/u/179495972?v=4" href="https://github.com/asiersinmasdev" height="64" width="64" border="1px" align="center"></kbd>
|
12
package.json
12
package.json
@ -1,22 +1,22 @@
|
|||||||
{
|
{
|
||||||
"author": "RageStudio",
|
"author": "RageStudio",
|
||||||
"license": "LGPL-2.1",
|
"license": "ComtyLicense",
|
||||||
"types": "index.d.ts",
|
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"wrapper:dev": "node ./packages/wrapper/src/index.js --dev",
|
|
||||||
"dev": "concurrently -k \"yarn dev:client\" \"yarn dev:server\"",
|
"dev": "concurrently -k \"yarn dev:client\" \"yarn dev:server\"",
|
||||||
"dev:server": "cd packages/server && yarn dev",
|
"dev:server": "cd packages/server && yarn dev",
|
||||||
"dev:client": "cd packages/app && yarn dev",
|
"dev:client": "cd packages/app && yarn dev",
|
||||||
"release": "node ./scripts/release.js",
|
"release": "node ./scripts/release.js",
|
||||||
"postdeploy": "node ./scripts/post-deploy.js",
|
"postdeploy": "node ./scripts/post-deploy.js",
|
||||||
"postinstall": "node ./scripts/post-install.js"
|
"postinstall": "node ./scripts/post-install.js",
|
||||||
|
"wrapper:dev": "node ./packages/wrapper/src/index.js --dev"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"7zip-min": "1.4.3",
|
"7zip-min": "1.4.3",
|
||||||
"axios": "^1.4.0",
|
|
||||||
"@ragestudio/hermes": "^0.1.1",
|
"@ragestudio/hermes": "^0.1.1",
|
||||||
|
"axios": "^1.4.0",
|
||||||
"dotenv": "16.0.3",
|
"dotenv": "16.0.3",
|
||||||
|
"mintlify": "^4.0.206",
|
||||||
"octokit": "^2.0.14"
|
"octokit": "^2.0.14"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
@ -26,4 +26,4 @@
|
|||||||
},
|
},
|
||||||
"_web_app_path": "packages/app",
|
"_web_app_path": "packages/app",
|
||||||
"version": "0.60.3"
|
"version": "0.60.3"
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user