|
1 | 1 | # daqserver |
2 | | -The main DAQ server repo |
| 2 | + |
| 3 | +The main DAQ server repo. |
| 4 | + |
| 5 | +## Running this project |
| 6 | + |
| 7 | +1. Download the command [`uv`](https://docs.astral.sh/uv/getting-started/installation/) to your computer |
| 8 | +2. Download [`git`](https://git-scm.com/install/) command to your computer |
| 9 | +3. Clone the project `git clone https://github.com/Highlander-Space-Program/daqserver.git` |
| 10 | +4. Get into the source code `cd daqserver` |
| 11 | +5. Run the project `uv run server` |
| 12 | + |
| 13 | +You don't need to download any Python for this, `uv` will download the right |
| 14 | +version and install all of the packages for you. |
| 15 | + |
| 16 | +## Development |
| 17 | + |
| 18 | +If you are going to add a new package to the python code, use `uv add |
| 19 | +package-name`. When you are committing code, I recommend following the [git |
| 20 | +commit conventions](https://www.conventionalcommits.org/en/v1.0.0/). For this |
| 21 | +project, I don't want anyone to directly push code to the `main` branch, unless |
| 22 | +you are doing a quick bugfix or fixing a typo. What you are going to do is push |
| 23 | +your local branch to this remote repository, and then create a pull request |
| 24 | +that is going to merge into the `main` branch. The DAQ lead or DAQ SE will look |
| 25 | +over your code in the pull request. If it is good, we will merge your code to |
| 26 | +the `main` branch, and if it is not good, we will ask you to make some changes. |
| 27 | +The idea here is that we want to keep `main` branch stable and not breaking. |
| 28 | +This means that you need to always create a new branch whenever you started |
| 29 | +working on your code. |
| 30 | + |
| 31 | +## I am confused |
| 32 | + |
| 33 | +This section here shows you how to navigate and use the codebase. If you have |
| 34 | +trouble with creating a pull request or how to use `git` you should try looking |
| 35 | +for a quick Youtube Tutorial or try asking ChatGPT, and then learn how to solve |
| 36 | +ur `git` problem, so you won't have to deal with it again later in the future. |
| 37 | + |
| 38 | +Under some directories like [`scripts`](./scripts) and [`server`](./server), |
| 39 | +you may find another `README.md` file. Inside of these `README.md` files, you |
| 40 | +will find guides and descriptions that will help you with navigating around the |
| 41 | +codebase. Don't afraid to ping the DAQ lead or the DAQ SE for help. Trying to |
| 42 | +figure out how to work with a new codebase yourself is difficult. When you are |
| 43 | +assigned a task for this project, you are expected to know a little bit of |
| 44 | +Python and also a little bit of `git`. Please don't ever use `git push --force` |
| 45 | +or `git push --force-with-lease` if you have no idea what you are doing. |
| 46 | + |
| 47 | +For those of you who already know a little bit about Python, it's a good idea |
| 48 | +to follow the [`PEP-8`](https://peps.python.org/pep-0008/) styling guide when |
| 49 | +adding your code to the project. If you want to challenge yourself a bit more |
| 50 | +(and I would be really happy if you do), try to make sure that everything you |
| 51 | +wrote is [type hinted](https://peps.python.org/pep-0484/) and tested through |
| 52 | +`pytest` (yes this means I would like you to write some unit tests for your |
| 53 | +code whenever possible). |
0 commit comments