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

Setup the COSMOS Repo and Improve the Setup Documentation #1204

Open
CarsonDavis opened this issue Jan 24, 2025 · 1 comment
Open

Setup the COSMOS Repo and Improve the Setup Documentation #1204

CarsonDavis opened this issue Jan 24, 2025 · 1 comment
Assignees

Comments

@CarsonDavis
Copy link
Collaborator

Description

Get the COSMOS repo running on your local environment.

Do this using the documentation provided in the repository, and if anything is badly documented, fix it to be more clear.

Implementation Considerations

  • you can talk to @dhanur-sharma to get a database backup to load onto your system
  • you will want to install some core technologies, such as python 3.10, docker, docker-compose, github cli

Deliverable

Updated documentation with improved contributing/installation procedure.

Dependencies

No response

@CarsonDavis
Copy link
Collaborator Author

CarsonDavis commented Jan 24, 2025

If you take a look at the CLI, you can spawn a feature branch off of this issue number. Instructions are in CONTRIBUTING.md. You will want to get started off the dev branch. Create a draft branch, turn it into a real pr when you are ready.

After you get COSMOS running, check out the django documentation at https://docs.djangoproject.com/en/4.2/intro/overview/. I would recommend you do the getting started guide.

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

When branches are created from issues, their pull requests are automatically linked.

2 participants