Skip to content

phamleduy04/hackutd24

BranchesTags

Repository files navigation

HACKUTD24

❯ REPLACE-ME

license last-commit repo-top-language repo-language-count

Built with the tools and technologies:

npm HTML5 JavaScript Docker Python TypeScript GitHub%20Actions Terraform


Table of Contents

📍 Overview

❯ REPLACE-ME

👾 Features

❯ REPLACE-ME

📁 Project Structure

└── hackutd24/
    ├── .github
    │   └── workflows
    ├── 3D_MODEL.md
    ├── backend
    │   ├── .dockerignore
    │   ├── .env.example
    │   ├── .gitignore
    │   ├── Dockerfile
    │   ├── baseline.jpg
    │   ├── docker-compose.yml
    │   ├── eslint.config.mjs
    │   ├── jest.config.js
    │   ├── package.json
    │   ├── pnpm-lock.yaml
    │   ├── src
    │   └── tsconfig.json
    ├── car-hub
    │   ├── .gitignore
    │   ├── Pipfile
    │   ├── Pipfile.lock
    │   ├── README.md
    │   └── main.py
    ├── embedded
    │   ├── .gitignore
    │   ├── .vscode
    │   ├── platformio.ini
    │   └── src
    ├── frontend
    │   ├── .gitignore
    │   ├── README.md
    │   ├── components.json
    │   ├── eslint.config.js
    │   ├── index.html
    │   ├── package.json
    │   ├── pnpm-lock.yaml
    │   ├── postcss.config.js
    │   ├── public
    │   ├── src
    │   ├── tailwind.config.js
    │   ├── tsconfig.app.json
    │   ├── tsconfig.json
    │   ├── tsconfig.node.json
    │   └── vite.config.ts
    ├── package.json
    ├── pnpm-lock.yaml
    ├── sonar-project.properties
    ├── terraform
    │   ├── .gitignore
    │   ├── README.md
    │   └── main.tf
    └── test.txt

📂 Project Index

HACKUTD24/
__root__
pnpm-lock.yaml ❯ REPLACE-ME
test.txt ❯ REPLACE-ME
package.json ❯ REPLACE-ME
.github
workflows
deploy.yml ❯ REPLACE-ME
pr-review.yml ❯ REPLACE-ME
eslint.yml ❯ REPLACE-ME
docker-build.yml ❯ REPLACE-ME
car-hub
Pipfile ❯ REPLACE-ME
main.py ❯ REPLACE-ME
backend
pnpm-lock.yaml ❯ REPLACE-ME
tsconfig.json ❯ REPLACE-ME
eslint.config.mjs ❯ REPLACE-ME
package.json ❯ REPLACE-ME
.env.example ❯ REPLACE-ME
docker-compose.yml ❯ REPLACE-ME
jest.config.js ❯ REPLACE-ME
Dockerfile ❯ REPLACE-ME
src
server.ts ❯ REPLACE-ME
app.ts ❯ REPLACE-ME
config
index.ts ❯ REPLACE-ME
cli
createPublicGroup.ts ❯ REPLACE-ME
pinata
index.ts ❯ REPLACE-ME
aiPrompt
index.ts ❯ REPLACE-ME
test
error.spec.ts ❯ REPLACE-ME
routes
index.spec.ts ❯ REPLACE-ME
routes
index.ts ❯ REPLACE-ME
api.ts ❯ REPLACE-ME
pushNotification
index.ts ❯ REPLACE-ME
terraform
main.tf ❯ REPLACE-ME
frontend
postcss.config.js ❯ REPLACE-ME
tsconfig.node.json ❯ REPLACE-ME
pnpm-lock.yaml ❯ REPLACE-ME
tsconfig.json ❯ REPLACE-ME
tailwind.config.js ❯ REPLACE-ME
tsconfig.app.json ❯ REPLACE-ME
package.json ❯ REPLACE-ME
vite.config.ts ❯ REPLACE-ME
index.html ❯ REPLACE-ME
components.json ❯ REPLACE-ME
eslint.config.js ❯ REPLACE-ME
src
main.tsx ❯ REPLACE-ME
index.css ❯ REPLACE-ME
App.css ❯ REPLACE-ME
vitest.setup.ts ❯ REPLACE-ME
App.tsx ❯ REPLACE-ME
vite-env.d.ts ❯ REPLACE-ME
lib
utils.ts ❯ REPLACE-ME
requests.ts ❯ REPLACE-ME
components
AppLayout.tsx ❯ REPLACE-ME
AppSidebar.tsx ❯ REPLACE-ME
Home.tsx ❯ REPLACE-ME
ui
sheet.tsx ❯ REPLACE-ME
badge.tsx ❯ REPLACE-ME
sidebar.tsx ❯ REPLACE-ME
scroll-area.tsx ❯ REPLACE-ME
input.tsx ❯ REPLACE-ME
separator.tsx ❯ REPLACE-ME
button.tsx ❯ REPLACE-ME
skeleton.tsx ❯ REPLACE-ME
tooltip.tsx ❯ REPLACE-ME
card.tsx ❯ REPLACE-ME
hooks
use-mobile.tsx ❯ REPLACE-ME
test
App.test.tsx ❯ REPLACE-ME
components
Home.test.tsx ❯ REPLACE-ME
embedded
platformio.ini ❯ REPLACE-ME
src
main.cpp ❯ REPLACE-ME

🚀 Getting Started

☑️ Prerequisites

Before getting started with hackutd24, ensure your runtime environment meets the following requirements:

  • Programming Language: TypeScript
  • Package Manager: Npm, Pipenv
  • Container Runtime: Docker

⚙️ Installation

Install hackutd24 using one of the following methods:

Build from source:

  1. Clone the hackutd24 repository:
❯ git clone https://github.com/phamleduy04/hackutd24
  1. Navigate to the project directory:
❯ cd hackutd24
  1. Install the project dependencies:

Using npm   

❯ npm install

Using pipenv   

❯ echo 'INSERT-INSTALL-COMMAND-HERE'

Using docker   

❯ docker build -t phamleduy04/hackutd24 .

🤖 Usage

Run hackutd24 using the following command: Using npm   

❯ npm start

Using pipenv   

❯ echo 'INSERT-RUN-COMMAND-HERE'

Using docker   

❯ docker run -it {image_name}

🧪 Testing

Run the test suite using the following command: Using npm   

❯ npm test

Using pipenv   

❯ echo 'INSERT-TEST-COMMAND-HERE'

📌 Project Roadmap

  • Task 1: Implement feature one.
  • Task 2: Implement feature two.
  • Task 3: Implement feature three.

🔰 Contributing

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your github account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client. 
    git clone https://github.com/phamleduy04/hackutd24
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name. 
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates. 
    git commit -m 'Implemented new feature x.'
  6. Push to github: Push the changes to your forked repository. 
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph

🎗 License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

🙌 Acknowledgments

  • List any resources, contributors, inspiration, etc. here.

About

Backtracc

backtracc.tech/

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages