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

readme lacks information to setup a development environment #860

Open
KaukaHan opened this issue Nov 22, 2021 · 4 comments
Open

readme lacks information to setup a development environment #860

KaukaHan opened this issue Nov 22, 2021 · 4 comments

Comments

@KaukaHan
Copy link
Contributor

the readme lacks essential information like the python version. witch is not in the default package-manager of my distro. Maybe a script that sets up everything automatically helps attracting more contributers.

@Brutus5000
Copy link
Member

You can look it up in the pipfile

server/Pipfile

Lines 43 to 44 in aac3d2c

[requires]
python_version = "3.7"

@KaukaHan
Copy link
Contributor Author

askaholic helped me setting up everything, but this is a barrier for people who contribute to software for their first time in their life like me. If i had not contacted anyone and just tried to follow the readme, the errors might have turned me down.

@Askaholic
Copy link
Collaborator

Yea there were a number of things that came up that should really be in the readme, like required software:

  • docker
  • Python 3.7 (with loadable SQLite extensions)
  • Pipenv

Nowhere does it say that you need to install these things. There were also a bunch of other things that I’ll have to go through our discord conversation again to remember.

@Askaholic
Copy link
Collaborator

Ok so from what I helped you with in Discord:

  • Install python3.7
  • Install docker
  • Add yourself to docker group
  • Install pipenv
  • Set PIPENV_VENV_IN_PROJECT=1 in bashrc (technically this is optional but I prefer this way)
  • Shut down some other service that was using port 4000 (OSError: [Errno 98] error while attempting to bind on address ('127.0.1.1', 4000): address already in use)
  • Update the database migration version in your faf-stack and run db migrations
  • Copy faf-stack template config
  • Recompile python with loadable sqlite extensions (necessary option when installing from source)
  • Install Atom plugins
    • linter-flake8
    • isort
  • Fork GitHub repo

These are kindof all the hoops we had to jump through chronologically. Probably not all of them make sense to go into detail on the server README (such as the faf-stack ones), but at least we should mention the potential issues that might arise and how to fix them.

Askaholic added a commit that referenced this issue Apr 2, 2022
* Update README

* Add codacy badge

* Split out detailed setup information to its own file

* Fix lint errors
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