OSAKI Project

Overview

The OSAKI Project is an open-source initiative aimed at creating an affordable, fuel-efficient kit car. Our goal is to design a vehicle that costs under $10,000 to build and delivers 80 mpg. By leveraging community contributions and innovative engineering, we're developing a customizable, eco-friendly two-seater that enthusiasts can assemble themselves.

Table of Contents

1. Project Vision
2. Getting Started
3. Development Environment
4. Contribution Guidelines
5. License
6. Contact

Project Vision

The OSAKI Project is focused on:

• Affordability: Keeping the build cost under $10,000.
• Fuel Efficiency: Achieving 80 miles per gallon.
• Customization: Allowing builders to modify and personalize their vehicles.
• Sustainability: Promoting eco-friendly automotive solutions.

Getting Started

To get started with contributing to the OSAKI Project, follow these steps:

Prerequisites

• Git: Make sure Git is installed on your local machine.
• Development Tools: Install necessary development tools and IDEs (e.g., VS Code).

Clone the Repository

git clone https://github.com/Stand-Motor-Company/Project-OSAKI.git
cd Project-OSAKI

Install Dependencies

Follow the instructions in the respective folders to install any necessary dependencies.

Build and Run

Instructions for building and running the project will vary based on the component (e.g., ECU software, dashboard UI). Refer to the documentation within each subdirectory for detailed steps.

Development Environment

We recommend using the following tools and environments:

• IDE: Visual Studio Code with Docker devcontainers.
• Simulation Tools: MATLAB/Simulink, Gazebo, QEMU.
• Version Control: GitHub for repository management.
• CI/CD: Jenkins for continuous integration and deployment.

Contribution Guidelines

We welcome contributions from the community! To contribute, please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of this page to create a copy of the repository on your GitHub account.
2. Clone Your Fork: Clone the forked repository to your local machine.
3. Create a Branch: Create a new branch for your feature or bug fix.

   git checkout -b feature/your-feature-name

4. Make Changes: Make your changes in the new branch.
5. Commit Changes: Commit your changes with a descriptive message.

   git commit -m "Add feature XYZ"

6. Push Changes: Push your changes to your forked repository.

   git push origin feature/your-feature-name

7. Create a Pull Request: Go to the original repository on GitHub and create a pull request from your forked branch.

License

The OSAKI Project license is to-be-determined. Safety is of the utmost concern, and great care is being taken to ensure that the selected license represents our unwavering adherance to the safety of the occupants, and places protections around ALL of the safety related software and hardware.

Contact

For questions or support, please reach out to us:

• Discord: Join our Discord server
• Email: warner@standmotors.com