docker-compose up
- DO NOT forget to set congifiration of outside docker in
/backend/backend/settings.py:DATABASES - Requirements:
node.jsyarnpython3postgresqlredis- Don't forget to start services
postgresqlandredis-server
- Don't forget to start services
- In directory
/backend, runpython3 manage.py runserver 0.0.0.0:8000to start backendpip install -r requirements-mini.txtpip install git+https://github.com/Ian-Foote/rest-framework-generic-relations.git
- In directory
makestorytogether,yarn startto start development mode of frontend- For first use, run
yarnto add dependencies
- For first use, run
- Backend HOST: default is
localhost. If there is need of remote testing, edit/makestorytogether/src/constans.js. - Redis Configure: https://github.com/kiki0805/Make-Story-Together/blob/master/backend/backend/settings.py#L107
- PostgreSql Configure: https://github.com/kiki0805/Make-Story-Together/blob/master/backend/backend/settings.py#L107
- Authentication based on Json Web Token
- RESTful API for almost all models used
- LIST / CREATE(POST) / DELETE / RETRIEVE / PATCH
- filter query by url params
- statistic for personal info (like registration time, number of plots created or timeline of some achievements)
- Signal of model creation to generate feeds
- only listen to creation of Group/Story yet
- Group/Story management page
- Ugly creation form yet
- Like or Unlike Story/Plot/Character
- something like follow
- (What this project finally aims to do) Write story with connecting to websocket specified by story_id
- Update the writing page immediately when here come new plots or chapters
- Handle Error HTTP Response
- Personal info page
- for now, only the own page is visited
- Discipline Functionality
- More interation UI interface
- Fit mobile user
- Control conflicts of simultaneously plot creation
- Refactory / reuser axio functions
- Model Details TBD
- group invitation
- email verification
- Beautiful UI Design
- Current ui are all based on Ant.design
- API Pagination
- Celery
- Cache to speed up / reselect in redux
/?screen_name=- search writer by screen_name
/register//signin//logout/
/group/{pk}/join//group/{pk}/quit//group/(?order=number)GETgroups listPOSTcreate group
/group/{pk}/GETfetch detailDELETEdelete group
/group/my/- owned groups list
/group/joined/- joined groups list
/group/remove_members/{"usernames": []}- remove members given list of usernames
/group/remove_discipline/{"discipline_id": }- remove discipline from rule
/group/apply_discipline/{"discipline_id": }- add discipline to rule
/story/(?order=number&&group={group_id})GETstories listPOSTcreate story
/story/{pk}/GETfetch detail- different serializers: story participator and normal user
DELETEdelete story
/story/my/- owned stories list
/story/joined/- joined stories list
/story/{pk}/plots/?chapter_id=/story/{pk}/chapters//story/{pk}/new_chapter/- POST DATA:
{"title": }
- POST DATA:
/story/{pk}/new_plot/- POST DATA:
{"content": , "chapter_id": }
- POST DATA:
/story/{pk}/clear_empty_content//story/{pk}/remove_invalid_plots//story/{pk}/get_characters/
/character/?story_id=- POST format:
{
"description": "",
"name": "",
"player": screen_name,
"story": id
}
/like/- POST format:
{
"liked_object": {"id":9,"model_name":"story","app_label":"stories"}
}