moonstream/moonstreamapi
Andrey Dolgolev 734bbaac5e
Merge pull request #846 from moonstream-to/revert-844-revert-826-add-tags-and-descriptions
Add tags and descriptions after revert
2023-07-13 17:51:48 +03:00
..
configs
deploy
moonstreamapi Merge pull request #846 from moonstream-to/revert-844-revert-826-add-tags-and-descriptions 2023-07-13 17:51:48 +03:00
scripts
.dockerignore
.gitignore
.isort.cfg
Dockerfile
README.md
dev.sh
mypy.ini
requirements.txt Updated moonstreamdb in requirements 2023-07-13 14:43:37 +00:00
setup.py Revert "Revert "Zksync support for moonstreamapi"" 2023-07-13 17:37:42 +03:00

README.md

moonstream backend

Installation and setup

To set up Moonstream API for development, do the following:

Run server with Docker

To be able to run Moonstream API with your existing local or development services as database, you need to build your own setup. Be aware! The files with environment variables docker.dev.env lives inside your docker container!

  • Copy configs/sample.env to configs/docker.dev.env, or use your local configs from configs/dev.env to configs/docker.dev.env
  • Edit in docker.dev.env file MOONSTREAM_DB_URI and other variables if required
  • Clean environment file from export prefix and quotation marks to be able to use it with Docker
sed --in-place 's|^export * ||' configs/docker.dev.env
sed --in-place 's|"||g' configs/docker.dev.env

Build container on your machine

docker build -t moonstreamapi-dev .

Run moonstreamapi-dev container, with following command we specified --network="host" setting which allows to Docker container use localhost interface of your machine (https://docs.docker.com/network/host/)

docker run --name moonstreamapi-dev \
  --network="host" \
  --env-file="configs/docker.dev.env" \
  -p 7481:7481/tcp \
  -ti -d moonstreamapi-dev

Attach to container to see logs

docker container attach moonstreamapi-dev