Skip to content

meyer1994/txtmap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TXTMAP

Build Status codecov

This is an open source clone of YourWorldOfText

Development

You can deploy your own version very easily. This project uses Serverless and is built using AWS Lambda and RDS. However, it should be fairly easy to port it to Heroku, Google Cloud or any other.

To make changes:

(venv) $ pip install -r requirements-dev.txt

To Test:

$ make postgres test  # Will start a postgres container, using docker
$ make report  # Code coverage

Stack

It uses AWS. Here is a list of the resources used:

  • 1 PostgreSQL (RDS)
  • 1 AWS Lambda Function
  • 1 API Gateway V2 (WebSockets)

Deploy

To deploy, you will need to have a database already up. We use SSM Parameter Store to store the DB password and host. See here for more info.

After everything is done, just execute:

$ serverless deploy --verbose

Releases

No releases published

Packages

No packages published

Languages