Initial commit
This commit is contained in:
20
docs/development.md
Normal file
20
docs/development.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Development
|
||||
|
||||
To host it the development server localy you need to install node and the ionic cli after that you need to pull the repo and host the local development server:
|
||||
```
|
||||
git pull https://github.com/jokerjoker10/uselessunit.git
|
||||
cd uselessunit
|
||||
ionic serve
|
||||
```
|
||||
|
||||
## Contributing
|
||||
If you want to contribute please create your own branch. If your code is ready please create a pull request from your branch to the dev Branch. The code will then be reviewed and if all is good it will be merged with the main branch and deployed.
|
||||
|
||||
## Naming Convention
|
||||
- variables: snake_case
|
||||
- functions: camelCase
|
||||
- classes: UpperCamelCase
|
||||
|
||||
|
||||
## Files
|
||||
The main action of the project happens in the src folder. The Pages are located in the src/pages directories. The calculation algorithms are located at src/util/calculator.ts.
|
||||
Reference in New Issue
Block a user