generated from partypages/party-template
75 lines
3.0 KiB
Markdown
75 lines
3.0 KiB
Markdown
# API
|
||
|
||
The API documentation is available [here](https://party.leafbla.de/api/docs)
|
||
|
||
# CI Setup
|
||
|
||
To enable automatic CI deployment for this repository, you need to do the following:
|
||
|
||
1. Adapt `.drone.yml` such that the output is deployed to where you want to.
|
||
|
||
By default, this is `<repo-name>.party.leafbla.de`.
|
||
|
||
1. Enable CI for the repository in [drone](https://drone.eterna.leafbla.de/).
|
||
|
||
Search the repository name in the search bar (you might need to click the "sync" button to make it show up) and click "activate repository"
|
||
|
||
1. Add the required secrets so that the CI can deploy to oreburgh
|
||
- Secret Name: `rsync_key`
|
||
|
||
Secret Value: Find "pelipper ssh key" in Bitwarden and paste the content of `id_rsa`
|
||
|
||
- Secret Name: `docker_config`
|
||
|
||
Secret Value: Find "Docker registry credentials" in Bitwarden and paste the content of the note.
|
||
|
||
The next time you push to the repository, the pipeline should run.
|
||
|
||
|
||
# Getting Started with Create React App
|
||
|
||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||
|
||
## Available Scripts
|
||
|
||
In the project directory, you can run:
|
||
|
||
### `npm start`
|
||
|
||
Runs the app in the development mode.\
|
||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||
|
||
The page will reload if you make edits.\
|
||
You will also see any lint errors in the console.
|
||
|
||
### `npm test`
|
||
|
||
Launches the test runner in the interactive watch mode.\
|
||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
||
|
||
### `npm run build`
|
||
|
||
Builds the app for production to the `build` folder.\
|
||
It correctly bundles React in production mode and optimizes the build for the best performance.
|
||
|
||
The build is minified and the filenames include the hashes.\
|
||
Your app is ready to be deployed!
|
||
|
||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
||
|
||
### `npm run eject`
|
||
|
||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
||
|
||
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
|
||
|
||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
|
||
|
||
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
|
||
|
||
## Learn More
|
||
|
||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
||
|
||
To learn React, check out the [React documentation](https://reactjs.org/).
|