Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoyirul/flask-starter-fs
https://github.com/hoyirul/flask-starter-fs
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hoyirul/flask-starter-fs
- Owner: hoyirul
- Created: 2023-11-08T09:42:09.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-23T06:17:09.000Z (about 1 year ago)
- Last Synced: 2023-11-24T02:28:51.160Z (about 1 year ago)
- Language: CSS
- Size: 210 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flask Template Full-Stack
Proyek ini merupakan aplikasi web yang dibangun menggunakan Flask, sebuah framework web Python yang ringan dan mudah digunakan. Aplikasi ini memiliki fitur query builder yang memungkinkan pengambilan data yang lebih fleksibel dan dinamis dari database MySQL.
## Deskripsi
Proyek ini merupakan Full-Stack yang dibangun menggunakan Flask, sebuah framework web Python yang ringan dan mudah digunakan. API ini menyediakan endpoints untuk mengelola data pada database MySQL dengan menggunakan fitur query builder yang memungkinkan pengambilan data yang lebih fleksibel dan dinamis.
## Fitur Utama
- Query Builder: Memanfaatkan query builder untuk menyusun dan mengeksekusi kueri SQL dengan mudah, termasuk fitur-fitur select, where, order by, dan group by.
- Relasi Model: Menggunakan fitur relasi model untuk mengelola hubungan antara tabel dengan mudah.
- User-Friendly: Antarmuka API yang sederhana dan mudah digunakan bagi para pengguna untuk berinteraksi dengan data.
## Cara Penggunaan
1. Pastikan Anda memiliki Python dan MySQL terinstal di komputer Anda.
2. Jika sudah mempunyai python silahkan jalankan di terminal anda (`pip3 install -U virtualenv`)
5. Membuat virualenv (`python3 -m venv venv`)
4. Lalu (`source ./venv/bin/activate`) MacOS atau (`venv\Scripts\activate`) Windows
5. Setelah itu silahkan jalankan di terminal anda (`pip3 install -r requirements.txt`)
6. Lalu jalankan (`cp .env.example .env`)
7. Setelah itu generate key dengan menjalankan (`python3 ./config/generate_key.py`)
2. Buat database dengan nama yang sesuai dalam MySQL.
3. Ubah konfigurasi database di file `.env` agar sesuai dengan pengaturan MySQL Anda.
4. Jalankan aplikasi dengan perintah berikut: (`python3 manage.py`)
5. Buka browser dan akses [http://127.0.0.1:8080](http://127.0.0.1:8080) untuk memulai penggunaan API.
## Penggunaan QueryBuilder
```sh
Penggunaan SELECT methods=['GET']
- exampleModel.builder().select(['id', 'title', 'description']).get()
Penggunaan Clausa WHERE methods=['GET']
- exampleModel.builder().where('id', '=', id).first()
Penggunaan Clausa ORDER BY methods=['GET']
- roleModel.builder().select(['id', 'role']).order_by('id', 'desc').get()
Penggunaan Clausa GROUP BY methods=['GET']
- roleModel.builder().select(['id', 'role']).group_by(['id', 'role']).get()
Penggunaan JOIN methods=['GET']
- response = userModel.builder().select(['users.id', 'users.email', 'users.password', 'roles.role']).join('roles', 'users.role_id = roles.id').get()
Penggunaan INSERT methods=['POST']
req = request.json
data = {
'title': f"'{req['title']}'",
'description': f"'{req['description']}'",
}
query = exampleModel.builder().insert(data).build()
exampleModel.execute(query)
Penggunaan UPDATE methods=['PUT']
req = request.json
data = {
'title': f"'{req['title']}'",
'description': f"'{req['description']}'",
}
query = exampleModel.builder().where('id', '=', id).update(data).build()
exampleModel.execute(query)
Penggunaan DELETE methods=['DELETE']
query = exampleModel.builder().where('id', '=', id).delete().build()
exampleModel.execute(query)
```
## Versi
**Versi 1.0.0**
## Kontribusi
Anda dapat berkontribusi pada proyek ini dengan cara berikut:
1. Fork proyek ini.
2. Buat branch baru (`git checkout -b fitur-anda`).
3. Lakukan perubahan pada kode Anda.
4. Commit perubahan (`git commit -m 'Menambahkan fitur baru'`).
5. Push ke branch (`git push origin fitur-anda`).
6. Buat Pull Request baru.
## Author
Mochammad Hairullah
Developer