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

How to get started? #1

Open
Siddharth1006 opened this issue Jan 20, 2021 · 1 comment
Open

How to get started? #1

Siddharth1006 opened this issue Jan 20, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Siddharth1006
Copy link

I am trying to work on this example project. But I don't find the instructions for the installations or anything.
Like should I use pipenv or venv ? Or any installations necessary to the run the manage.py file? Can someone guide me on this.. I am trying to learn dj-stripe and thought this would be the right place to start..

@kavdev
Copy link
Member

kavdev commented Feb 24, 2021

@Siddharth1006 I agree we could use a bit more documentation; PRs are welcome :)

For now, the pyproject.toml file tells you everything you need to know about getting the project up and running.

  • Use https://python-poetry.org/ as the build system (poetry install, poetry shell)
  • Set your environment variables (instructions out of scope for this guide)
  • Migrate using poetry run migrate
  • Run the server using poetry run dev or poetry run start
  • Open your browser

@kavdev kavdev changed the title Where is the README.MD? How to get started? Feb 24, 2021
@kavdev kavdev added the documentation Improvements or additions to documentation label Feb 24, 2021
@kavdev kavdev pinned this issue Feb 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants