Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readme #30

Open
matthew-white opened this issue Apr 27, 2020 · 4 comments
Open

Add readme #30

matthew-white opened this issue Apr 27, 2020 · 4 comments

Comments

@matthew-white
Copy link
Member

getodk has a few different XLSForm-related repositories (and would have one more with pyxform-http), so it might be useful to add a short readme here explicitly connecting this repository to the XLSForm Online web app.

@yanokwa
Copy link
Member

yanokwa commented Apr 28, 2020

@getodk-bot claim

@getodk-bot
Copy link
Member

getodk-bot commented May 9, 2020

Hello @yanokwa, you have been unassigned from this issue because you have not updated this issue or any referenced pull requests for over 15 days.

You can reclaim this issue or claim any other issue by commenting @getodk-bot claim on that issue.

Thanks for your contributions, and hope to see you again soon!

@matthew-white
Copy link
Member Author

Ideas for things that could be documented in a readme:

  • How to run the app
  • List of environment variables. I needed to set DJANGO_SECRET_KEY and DJANGO_TMP_HOME.
  • How are static assets served? Do I need to configure something? I get 404s for bootstrap.min.css and jquery.min.js.

@yanokwa
Copy link
Member

yanokwa commented Aug 8, 2023

Just so I don't forget, the rough instructions are...

pip3 install -r requirements.txt
export DJANGO_SECRET_KEY=SECRET
export DJANGO_TMP_HOME=/tmp
python3 manage.py migrate
python3 manage.py collectstatic --noinput
python3 manage.py runserver

We should probably package this is Docker.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants