Skip to content

Commit

Permalink
Implement weight log feature, user management, admin routes, and API …
Browse files Browse the repository at this point in the history
…documentation with Scribe
  • Loading branch information
kennedyowusu committed Dec 31, 2024
0 parents commit 6cd6e1a
Show file tree
Hide file tree
Showing 119 changed files with 25,154 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{yml,yaml}]
indent_size = 2

[docker-compose.yml]
indent_size = 4
66 changes: 66 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
APP_NAME=Laravel
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_TIMEZONE=UTC
APP_URL=http://localhost

APP_LOCALE=en
APP_FALLBACK_LOCALE=en
APP_FAKER_LOCALE=en_US

APP_MAINTENANCE_DRIVER=file
# APP_MAINTENANCE_STORE=database

PHP_CLI_SERVER_WORKERS=4

BCRYPT_ROUNDS=12

LOG_CHANNEL=stack
LOG_STACK=single
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=daily_weight_logs_api
DB_USERNAME=root
DB_PASSWORD=

SESSION_DRIVER=database
SESSION_LIFETIME=120
SESSION_ENCRYPT=false
SESSION_PATH=/
SESSION_DOMAIN=null

BROADCAST_CONNECTION=log
FILESYSTEM_DISK=local
QUEUE_CONNECTION=database

CACHE_STORE=database
CACHE_PREFIX=

MEMCACHED_HOST=127.0.0.1

REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=log
MAIL_SCHEME=null
MAIL_HOST=127.0.0.1
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_FROM_ADDRESS="[email protected]"
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

VITE_APP_NAME="${APP_NAME}"
11 changes: 11 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
* text=auto eol=lf

*.blade.php diff=html
*.css diff=css
*.html diff=html
*.md diff=markdown
*.php diff=php

/.github export-ignore
CHANGELOG.md export-ignore
.styleci.yml export-ignore
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/.phpunit.cache
/node_modules
/public/build
/public/hot
/public/storage
/storage/*.key
/storage/pail
/vendor
.env
.env.backup
.env.production
.phpactor.json
.phpunit.result.cache
Homestead.json
Homestead.yaml
auth.json
npm-debug.log
yarn-error.log
/.fleet
/.idea
/.nova
/.vscode
/.zed
.history/**/*
4 changes: 4 additions & 0 deletions .scribe/.filehashes
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
# Scribe uses this file to know when you change something manually in your docs.
.scribe/intro.md=c01f16c622132cbe2797085dcd335e9f
.scribe/auth.md=9bee2b1ef8a238b2e58613fa636d5f39
3 changes: 3 additions & 0 deletions .scribe/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Authenticating requests

This API is not authenticated.
223 changes: 223 additions & 0 deletions .scribe/endpoints.cache/00.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
## Autogenerated by Scribe. DO NOT MODIFY.

name: Authentication
description: |-
Endpoints for user authentication.
endpoints:
-
httpMethods:
- POST
uri: api/v1/register
metadata:
groupName: Authentication
groupDescription: |-
Endpoints for user authentication.
subgroup: ''
subgroupDescription: ''
title: 'Register a new user.'
description: ''
authenticated: false
custom: []
headers:
Content-Type: application/json
Accept: application/json
urlParameters: []
cleanUrlParameters: []
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the user.'
required: true
example: 'John Doe'
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
username:
name: username
description: 'The username.'
required: true
example: johndoe
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
country:
name: country
description: 'Must not be greater than 255 characters.'
required: false
example: qvifykhqhxluiehv
type: string
enumValues: []
exampleWasSpecified: false
nullable: true
custom: []
email:
name: email
description: 'The email address.'
required: true
example: [email protected]
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
password:
name: password
description: 'The password.'
required: true
example: password
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
password_confirmation:
name: password_confirmation
description: 'The password confirmation.'
required: true
example: password
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
cleanBodyParameters:
name: 'John Doe'
username: johndoe
country: qvifykhqhxluiehv
email: [email protected]
password: password
password_confirmation: password
fileParameters: []
responses:
-
status: 201
content: |-
{
"message": "Registration successful.",
...
}
headers: []
description: ''
custom: []
responseFields: []
auth: []
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: api/v1/login
metadata:
groupName: Authentication
groupDescription: |-
Endpoints for user authentication.
subgroup: ''
subgroupDescription: ''
title: 'Login a user.'
description: ''
authenticated: false
custom: []
headers:
Content-Type: application/json
Accept: application/json
urlParameters: []
cleanUrlParameters: []
queryParameters: []
cleanQueryParameters: []
bodyParameters:
email:
name: email
description: 'The email address.'
required: true
example: [email protected]
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
password:
name: password
description: 'The password.'
required: true
example: password
type: string
enumValues: []
exampleWasSpecified: true
nullable: false
custom: []
cleanBodyParameters:
email: [email protected]
password: password
fileParameters: []
responses:
-
status: 200
content: |-
{
"message": "Login successful.",
...
}
headers: []
description: ''
custom: []
-
status: 401
content: '{"message": "Invalid credentials."}'
headers: []
description: ''
custom: []
responseFields: []
auth: []
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: api/v1/logout
metadata:
groupName: Authentication
groupDescription: |-
Endpoints for user authentication.
subgroup: ''
subgroupDescription: ''
title: 'Logout the authenticated user.'
description: ''
authenticated: false
custom: []
headers:
Content-Type: application/json
Accept: application/json
urlParameters: []
cleanUrlParameters: []
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"message": "Logout successful."}'
headers: []
description: ''
custom: []
responseFields: []
auth: []
controller: null
method: null
route: null
custom: []
Loading

0 comments on commit 6cd6e1a

Please sign in to comment.