tzvio / cockroachdb-todo-apps Goto Github PK

Code newbies and new open source contributors -- help us build our repository of CockroachDB To-Do apps!

Build a To-Do app using CockroachDB and a language/ORM of your choice!

Note: Feel free to contribute your own app even if there's already one for the language of your choice. It's okay to have multiple apps using the same language as long as you don't plagiarize.

CockroachDB is the distributed SQL database built to scale fast, survive anything, and thrive everywhere. Whether you are a single-person startup or a global enterprise, CockroachDB was designed to make managing data easy. To learn more about CockroachDB, see our website and docs.

If you are new to open source or need a GitHub refresher, open your first pull request in the First Contributions repository.

Note for Hacktoberfest participants: The First Contributions repository is the only educational repository considered valid for Hacktoberfest contributions. Opening a Pull Request for this repository counts towards your Hacktoberfest contributions!

1. Click Fork to fork this repository.
2. Clone your forked repository to your laptop:
   1. From your GitHub account page, open the forked repository and click Code. Then click the copy-to-clipboard button.
   2. Open a terminal and run the following command: git clone <url-you-just-copied>
3. Create a branch named <programming language>_ToDoApp_<your name>:
   1. On your laptop, navigate to the repository: cd cockroachdb-todo-apps
   2. Create a branch: git checkout -b <programming language>_ToDoApp_<your name>
4. Copy the template_ToDoApp directory and rename it to <programming language>_ToDoApp_<your name>.
   1. cp template_ToDoApp <programming language>_ToDoApp_<your name>
   2. cd <programming language>_ToDoApp_<your name>

1. Install CockroachDB.
2. Start a local CockroachDB cluster.
3. In the directory you created in Step 2, write the code for your to-do app using your CockroachDB cluster. For a sample app, see https://github.com/cockroachdb/examples-python

1. Add, commit, and push the folder to your branch.
   1. cd ..
   2. git add <programming language>_ToDoApp_<your name>
   3. git commit -m "Added To-Do app for <programming language>"
   4. git push -u origin <programming language>_ToDoApp_<your name>
2. Open a pull request!

This challenge has three parts: Learn how to contribute to open source projects, learn CockroachDB, and learn how to build apps. Each part of this challenge can be overwhelming if it is new to you. Take your time with the challenge -- pace yourself and be patient with yourself. And don't hesitate to reach out to our community if you need help.

Join our Community Slack (there's a dedicated #contributors channel!) to ask questions, discuss your ideas, or connect with other contributors.

Please follow the guidelines outlined in our Code of Conduct to help us make the CockroachDB community a welcoming and helpful place for everyone.