core-hacked / tesla-alerts-dictionary Goto Github PK

This repository aims to provide a dictionary of Tesla alerts and their meanings including an option to search for them.
View Website · Report Issue · Contribute

• HTML5
• JavaScript
• Flowbite
• Webpack

To get a local copy up and running follow these simple steps.

You can deploy the server however you want, this is just an example of how you can do it.

• Apache (for debian-based systems / using apt)

  sudo apt install apache2

• Apache (for arch-based systems / using pacman)

  pacman -S apache

1. Clone the repo

   git clone https://github.com/core-hacked/tesla-alerts-dictionary.git

2. Start an Apache server to run the repo

   /etc/init.d/apache2 start

   Or on Debian 8.x+ based systems | Or on Ubuntu 15.04+

   systemctl start apache2.service

3. Copy the repo to the Apache server

   cp -r tesla-alerts-dictionary/ /var/www/html/

4. Open the website in your browser
 ```sh
 http://localhost/tesla-alerts-dictionary/

1. Install the dependencies

    npm install

2. Build the project. The JavaScript file will be generated in the dist folder.

    npm run build

3. Configure / run TailwindCSS to generate the CSS file. The CSS file will be generated in the dist folder. It will also watch for changes to the src folder and inside the HTML and automatically update the output.css file in /dist/.

    npx tailwindcss -i ./src/input.css -o ./dist/output.css --watch

4. If you update the alerts dictionary/files inside the /alerts/ folder, be sure to run the maker.py script to automatically generate the buttons for the alerts. Then just copy them into index.html. If needed reference the index.html file in the /src/ folder. The buttons will be generated into the alerts_index.html file.

   cd tools/
   python3 maker.py

5. When contributing, be sure to run prettier to format the code. You may ignore the alert buttons as they take a lot of time to format. Don't forget to delete the alerts_index.html file after you're done.

See the open issues for a list of proposed features (and known issues).

• Document alerts, fix typos, and add more infomation.
• Fix the header/button overlap when a successful search is made.
• Fix not being able to return to home on fullscreen/new-tab alerts when using as PWA
• Possibly add a button to copy the alert code to the clipboard.
• Make the buttons in the alert popup more mobile friendly/less cramped.
• Autofocus/search when CTRL + F is pressed.
• Make the search system not depend on buttons inside the dom, but rather a json file.
• Let js generate the buttons from the json file, instead of having to manually copy them into the html file.
• Sync the creation process to GitHub Actions on PRs.
• Streamline the deployment process, and make it a one-click deploy.

Contributions are what make the open source community such an amazing place to be... learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the GNU GPL v3 License. See LICENSE for more information.

[email protected]