Skip to content
Snippets Groups Projects
README.md 2.46 KiB
Newer Older
Sigmund, Dominik's avatar
Sigmund, Dominik committed
# DataSmith

Sigmund, Dominik's avatar
Sigmund, Dominik committed
Create a Database from Scratch using a CLI like angular ng.
Sigmund, Dominik's avatar
Sigmund, Dominik committed


Sigmund, Dominik's avatar
Sigmund, Dominik committed
## Installation
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
```bash
  sudo apt-get install git
Sigmund, Dominik's avatar
Sigmund, Dominik committed
```

Sigmund, Dominik's avatar
Sigmund, Dominik committed
```bash
git https://gitlab.ard.de/apps/datasmith.git
cd datasmith
go build -o ds
ln -s $PWD/ds /usr/local/bin/ds
chmod +x /usr/local/bin/ds
```
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
## Usage
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
```bash
ds
```
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
### Create a new project
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
```bash
ds init
```
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
### Add a new table
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
```bash
ds add
```

```bash
ds add "Table Name"
```

```bash
ds add users --model '{"fields":[{"name":"id","type":"INT","primary_key":true,"auto_increment":true,"not_null":true},{"name":"name","type":"VARCHAR(255)","unique":true,"not_null":true},{"name":"email","type":"VARCHAR(255)","unique":true,"not_null":true},{"name":"created_at","type":"DATETIME","not_null":true,"default_value":"CURRENT_TIMESTAMP"}]}'
Sigmund, Dominik's avatar
Sigmund, Dominik committed
```
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
## Contributing
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
We welcome contributions from the community! If you'd like to contribute to DataSmith, please follow [these guidelines](CONTRIBUTING.md) to help us ensure that your changes are successfully integrated into the project.
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
## License
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
BuzzBoard Database is licensed under the [MIT License](LICENSE.md). Feel free to use, modify, and distribute it according to your needs.
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
## Authors
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
- **[Dominik Sigmund](https://gitlab.ard.de/dominik.sigmund)** - Lead Developer
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
## Acknowledgments
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
We appreciate the collaborative efforts that have contributed to the success of DataSmith. We'd like to thank the following individuals and organizations for their support and contributions:
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
- (none yet, but you could be the first!)
Sigmund, Dominik's avatar
Sigmund, Dominik committed

## Support

Sigmund, Dominik's avatar
Sigmund, Dominik committed
If you can't find a solution to your issue in the documentation, feel free to reach out to us for assistance. We offer support through the following channels:
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
- **Email:** For non-urgent matters or if you prefer email communication, you can reach us at [apps.datasmith@br.de](mailto:buzzboard@br.de). Please provide detailed information about your issue so that we can assist you more effectively.
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
## Important Note
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
When seeking support, make sure to include the following information in your message:
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
1. A detailed description of the issue you're facing.
2. Steps to reproduce the problem (if applicable).
3. Relevant configuration details.
4. Any error messages or logs related to the issue.
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
This information will help us understand your situation better and provide a more accurate and timely response.
Sigmund, Dominik's avatar
Sigmund, Dominik committed

Sigmund, Dominik's avatar
Sigmund, Dominik committed
Thank you for choosing DataSmith!! We're committed to ensuring you have a positive experience, and we appreciate your cooperation in following these support guidelines.