Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

f-branch-1 #12

Merged
merged 4 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

A fast and efficient **Vehicle Allocation System** built using **FastAPI** and **MongoDB**, designed to allow employees to allocate vehicles for specific dates, manage allocation statuses, and handle driver assignments. The system ensures that a vehicle is not double-booked and enforces date restrictions to prevent allocation modifications after the allocation date.

![Banner](./docs-docusaurus/static/img/vallocation_banner.png)

> [!NOTE]
> Please check the [official website](https://fahimfba.github.io/vallocation/) for the complete instructions along with some popular resources!

Expand Down Expand Up @@ -99,10 +101,13 @@ The API will now be available at `http://127.0.0.1:8000`.
```bash
vallocation/
├── .github/ # Action Workflows
├── config/
│ └── database.py # Database configuration for MongoDB
├── docs/ # Documentation (Docusaurus)
├── docs/ # Documentation (Static Site - Generated by Docusaurus)
├── docs-docusaurus/ # Documentation (Docusaurus)
├── models/
│ └── vallocation_model.py # Pydantic model for vehicle allocations
Expand All @@ -117,6 +122,7 @@ vallocation/
├── .gitignore # Git ignore rules
├── LICENSE # License file for the project
├── main.py # Entry point of the FastAPI application
├── README.md # Repository README
├── requirements.txt # Python dependencies for the project
```

Expand Down Expand Up @@ -259,5 +265,5 @@ Each allocation is stored in MongoDB in the following format:
- **Fahim** - Developer, Architect
- **[Contributors](https://github.com/FahimFBA/vallocation/contributors)**

Feel free to open issues or submit pull requests to help improve this project!
Feel free to open [issues](https://github.com/FahimFBA/vallocation/issues) or submit [pull requests](https://github.com/FahimFBA/vallocation/pulls) to help improve this project!

8 changes: 6 additions & 2 deletions docs-docusaurus/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,13 @@ The API will now be available at `http://127.0.0.1:8000`.
```bash
vallocation/
├── .github/ # Action Workflows
├── config/
│ └── database.py # Database configuration for MongoDB
├── docs/ # Documentation (Docusaurus)
├── docs/ # Documentation (Static Site - Generated by Docusaurus)
├── docs-docusaurus/ # Documentation (Docusaurus)
├── models/
│ └── vallocation_model.py # Pydantic model for vehicle allocations
Expand All @@ -120,6 +123,7 @@ vallocation/
├── .gitignore # Git ignore rules
├── LICENSE # License file for the project
├── main.py # Entry point of the FastAPI application
├── README.md # Repository README
├── requirements.txt # Python dependencies for the project
```

Expand Down Expand Up @@ -264,5 +268,5 @@ Each allocation is stored in MongoDB in the following format:
- **Fahim** - Developer, Architect
- **[Contributors](https://github.com/FahimFBA/vallocation/contributors)**

Feel free to open issues or submit pull requests to help improve this project!
Feel free to open [issues](https://github.com/FahimFBA/vallocation/issues) or submit [pull requests](https://github.com/FahimFBA/vallocation/pulls) to help improve this project!

2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.5.2">
<title data-rh="true">Page Not Found | Vehicle Allocation (Vallocation)</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" name="twitter:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" property="og:url" content="https://fahimfba.github.io/vallocation/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Vehicle Allocation (Vallocation)"><link data-rh="true" rel="icon" href="/vallocation/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://fahimfba.github.io/vallocation/404.html"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/404.html" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/vallocation/blog/rss.xml" title="Vehicle Allocation (Vallocation) RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/vallocation/blog/atom.xml" title="Vehicle Allocation (Vallocation) Atom Feed"><link rel="stylesheet" href="/vallocation/assets/css/styles.4a2f474a.css">
<script src="/vallocation/assets/js/runtime~main.58487620.js" defer="defer"></script>
<script src="/vallocation/assets/js/runtime~main.5aa29cb0.js" defer="defer"></script>
<script src="/vallocation/assets/js/main.0376d320.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/js/0e384e19.4e1704de.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/js/runtime~main.5aa29cb0.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/blog/archive/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.5.2">
<title data-rh="true">Archive | Vehicle Allocation (Vallocation)</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" name="twitter:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" property="og:url" content="https://fahimfba.github.io/vallocation/blog/archive"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Archive | Vehicle Allocation (Vallocation)"><meta data-rh="true" name="description" content="Archive"><meta data-rh="true" property="og:description" content="Archive"><link data-rh="true" rel="icon" href="/vallocation/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://fahimfba.github.io/vallocation/blog/archive"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/archive" hreflang="en"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/archive" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/vallocation/blog/rss.xml" title="Vehicle Allocation (Vallocation) RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/vallocation/blog/atom.xml" title="Vehicle Allocation (Vallocation) Atom Feed"><link rel="stylesheet" href="/vallocation/assets/css/styles.4a2f474a.css">
<script src="/vallocation/assets/js/runtime~main.58487620.js" defer="defer"></script>
<script src="/vallocation/assets/js/runtime~main.5aa29cb0.js" defer="defer"></script>
<script src="/vallocation/assets/js/main.0376d320.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/authors/all-sebastien-lorber-articles/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.5.2">
<title data-rh="true">Sébastien Lorber - 3 posts | Vehicle Allocation (Vallocation)</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" name="twitter:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" property="og:url" content="https://fahimfba.github.io/vallocation/blog/authors/all-sebastien-lorber-articles"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" property="og:title" content="Sébastien Lorber - 3 posts | Vehicle Allocation (Vallocation)"><meta data-rh="true" name="docusaurus_tag" content="blog_authors_posts"><meta data-rh="true" name="docsearch:docusaurus_tag" content="blog_authors_posts"><link data-rh="true" rel="icon" href="/vallocation/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://fahimfba.github.io/vallocation/blog/authors/all-sebastien-lorber-articles"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/authors/all-sebastien-lorber-articles" hreflang="en"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/authors/all-sebastien-lorber-articles" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/vallocation/blog/rss.xml" title="Vehicle Allocation (Vallocation) RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/vallocation/blog/atom.xml" title="Vehicle Allocation (Vallocation) Atom Feed"><link rel="stylesheet" href="/vallocation/assets/css/styles.4a2f474a.css">
<script src="/vallocation/assets/js/runtime~main.58487620.js" defer="defer"></script>
<script src="/vallocation/assets/js/runtime~main.5aa29cb0.js" defer="defer"></script>
<script src="/vallocation/assets/js/main.0376d320.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/authors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.5.2">
<title data-rh="true">Authors | Vehicle Allocation (Vallocation)</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" name="twitter:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" property="og:url" content="https://fahimfba.github.io/vallocation/blog/authors"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" property="og:title" content="Authors | Vehicle Allocation (Vallocation)"><meta data-rh="true" name="docusaurus_tag" content="blog_authors_list"><meta data-rh="true" name="docsearch:docusaurus_tag" content="blog_authors_list"><link data-rh="true" rel="icon" href="/vallocation/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://fahimfba.github.io/vallocation/blog/authors"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/authors" hreflang="en"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/authors" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/vallocation/blog/rss.xml" title="Vehicle Allocation (Vallocation) RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/vallocation/blog/atom.xml" title="Vehicle Allocation (Vallocation) Atom Feed"><link rel="stylesheet" href="/vallocation/assets/css/styles.4a2f474a.css">
<script src="/vallocation/assets/js/runtime~main.58487620.js" defer="defer"></script>
<script src="/vallocation/assets/js/runtime~main.5aa29cb0.js" defer="defer"></script>
<script src="/vallocation/assets/js/main.0376d320.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/authors/yangshun/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.5.2">
<title data-rh="true">Yangshun Tay - 3 posts | Vehicle Allocation (Vallocation)</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" name="twitter:image" content="https://fahimfba.github.io/vallocation/img/vallocation_banner.png"><meta data-rh="true" property="og:url" content="https://fahimfba.github.io/vallocation/blog/authors/yangshun"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" property="og:title" content="Yangshun Tay - 3 posts | Vehicle Allocation (Vallocation)"><meta data-rh="true" name="docusaurus_tag" content="blog_authors_posts"><meta data-rh="true" name="docsearch:docusaurus_tag" content="blog_authors_posts"><link data-rh="true" rel="icon" href="/vallocation/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://fahimfba.github.io/vallocation/blog/authors/yangshun"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/authors/yangshun" hreflang="en"><link data-rh="true" rel="alternate" href="https://fahimfba.github.io/vallocation/blog/authors/yangshun" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/vallocation/blog/rss.xml" title="Vehicle Allocation (Vallocation) RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/vallocation/blog/atom.xml" title="Vehicle Allocation (Vallocation) Atom Feed"><link rel="stylesheet" href="/vallocation/assets/css/styles.4a2f474a.css">
<script src="/vallocation/assets/js/runtime~main.58487620.js" defer="defer"></script>
<script src="/vallocation/assets/js/runtime~main.5aa29cb0.js" defer="defer"></script>
<script src="/vallocation/assets/js/main.0376d320.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
Loading