mirror of
https://github.com/OSMA-D/osma-server.git
synced 2025-03-01 07:41:25 +03:00
doc: readme contributing roadmap
This commit is contained in:
parent
11628b0190
commit
2cf76d8c0f
9 changed files with 342 additions and 2 deletions
55
docs/db-validation/apps.json
Normal file
55
docs/db-validation/apps.json
Normal file
|
@ -0,0 +1,55 @@
|
|||
{
|
||||
"$jsonSchema": {
|
||||
"bsonType": "object",
|
||||
"required": [
|
||||
"app_id",
|
||||
"name",
|
||||
"description",
|
||||
"icon",
|
||||
"screenshots",
|
||||
"repo",
|
||||
"author",
|
||||
"tags"
|
||||
],
|
||||
"properties": {
|
||||
"app_id": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 5
|
||||
},
|
||||
"name": {
|
||||
"bsonType": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 16
|
||||
},
|
||||
"description": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"icon": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"screenshots": {
|
||||
"bsonType": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"repo": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"author": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 16
|
||||
},
|
||||
"tags": {
|
||||
"bsonType": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 32
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
28
docs/db-validation/apps_versions.json
Normal file
28
docs/db-validation/apps_versions.json
Normal file
|
@ -0,0 +1,28 @@
|
|||
{
|
||||
"$jsonSchema": {
|
||||
"bsonType": "object",
|
||||
"required": ["app_id", "version", "url", "timestamp", "platform", "type"],
|
||||
"properties": {
|
||||
"name_id": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 5
|
||||
},
|
||||
"version": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"url": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"platform": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"type": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"timestamp": {
|
||||
"bsonType": "number"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
22
docs/db-validation/personal_libraries.json
Normal file
22
docs/db-validation/personal_libraries.json
Normal file
|
@ -0,0 +1,22 @@
|
|||
{
|
||||
"$jsonSchema": {
|
||||
"bsonType": "object",
|
||||
"required": ["apps", "name"],
|
||||
"properties": {
|
||||
"name": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 16
|
||||
},
|
||||
"apps": {
|
||||
"bsonType": "array",
|
||||
"uniqueItems": true,
|
||||
"items": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 5
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
32
docs/db-validation/reviews.json
Normal file
32
docs/db-validation/reviews.json
Normal file
|
@ -0,0 +1,32 @@
|
|||
{
|
||||
"$jsonSchema": {
|
||||
"bsonType": "object",
|
||||
"required": ["app_id", "user_name", "text", "score", "timestamp"],
|
||||
"properties": {
|
||||
"app_id": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 5
|
||||
},
|
||||
"user_name": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 16
|
||||
},
|
||||
"score": {
|
||||
"bsonType": "number",
|
||||
"minimum": 1,
|
||||
"maximum": 10
|
||||
},
|
||||
"text": {
|
||||
"bsonType": "string",
|
||||
"minLength": 2,
|
||||
"maxLength": 2000
|
||||
},
|
||||
"timestamp": {
|
||||
"bsonType": "number",
|
||||
"minimum": 1658995612
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
22
docs/db-validation/users.json
Normal file
22
docs/db-validation/users.json
Normal file
|
@ -0,0 +1,22 @@
|
|||
{
|
||||
"$jsonSchema": {
|
||||
"bsonType": "object",
|
||||
"required": ["name", "password", "email", "role"],
|
||||
"properties": {
|
||||
"name": {
|
||||
"bsonType": "string",
|
||||
"minLength": 3,
|
||||
"maxLength": 16
|
||||
},
|
||||
"password": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"email": {
|
||||
"bsonType": "string"
|
||||
},
|
||||
"role": {
|
||||
"bsonType": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
0
docs/guides/getting-started.md
Normal file
0
docs/guides/getting-started.md
Normal file
83
docs/roadmap.md
Normal file
83
docs/roadmap.md
Normal file
|
@ -0,0 +1,83 @@
|
|||
# OSMA-Server Roadmap
|
||||
|
||||
These are just server features, there is also an osma application, it will also have many features.
|
||||
|
||||
## 1.0.0 (current)
|
||||
|
||||
### Features
|
||||
|
||||
#### Apps
|
||||
|
||||
- [x] Get All apps
|
||||
- [x] Get app by app_id
|
||||
- [x] Get apps by tags
|
||||
- [x] Get app versions by app_id
|
||||
- [x] Get latest app version by app_id
|
||||
- [x] Getting the app rating
|
||||
|
||||
#### Reviews
|
||||
|
||||
- [x] Writing reviews and editing
|
||||
- [x] Get reviews by app id
|
||||
|
||||
#### Personal libraries (downloads list)
|
||||
|
||||
- [x] Get personal Library
|
||||
- [x] Add app to personal library (downloads)
|
||||
|
||||
#### Users
|
||||
|
||||
- [x] Auth/Authorisation api
|
||||
- [x] Update user info
|
||||
- [x] Change user password
|
||||
|
||||
---
|
||||
|
||||
## 1.1.\*
|
||||
|
||||
### Features
|
||||
|
||||
#### Users
|
||||
|
||||
- [ ] Email confirmation
|
||||
- [ ] Password Recovery
|
||||
|
||||
#### Reviews
|
||||
|
||||
- [ ] Review sorting (negative, positive)
|
||||
|
||||
#### Apps
|
||||
|
||||
- [ ] Getting the number of app downloads
|
||||
|
||||
...And more `the list is not complete`
|
||||
|
||||
---
|
||||
|
||||
## 1.2.\*
|
||||
|
||||
### Features
|
||||
|
||||
#### Users
|
||||
|
||||
- [ ] Creating a developer account
|
||||
|
||||
#### Apps
|
||||
|
||||
- [ ] The ability to publish your application in osma
|
||||
|
||||
...And more `the list is not complete`
|
||||
|
||||
---
|
||||
|
||||
## After receiving the investment, it is possible
|
||||
|
||||
- [ ] Investments received
|
||||
- [ ] Own hosting for application files
|
||||
|
||||
### Features
|
||||
|
||||
- [ ] Uploading new versions to osma hosting
|
||||
- [ ] IPFS Support for app downloading
|
||||
|
||||
---
|
Loading…
Add table
Reference in a new issue