Skip to content

Commit

Permalink
feat: init [#1]
Browse files Browse the repository at this point in the history
  • Loading branch information
d3p1 committed Oct 12, 2024
0 parents commit cd66ffa
Show file tree
Hide file tree
Showing 13 changed files with 5,293 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["@d3p1/commitlint-config"]
}
22 changes: 22 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
##
# @description Dockerfile for Dev Container
# @author C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
##
FROM node:18

##
# @note Install basic development tools
##
RUN apt update && apt install -y less man-db sudo

##
# @note Ensure default `node` user has access to `sudo`
##
ARG USERNAME=node
RUN echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
&& chmod 0440 /etc/sudoers.d/$USERNAME

##
# @note Set `DEVCONTAINER` environment variable to help with orientation
##
ENV DEVCONTAINER=true
11 changes: 11 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/**
* @description Dev Container configuration
* @author C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
*/
{
"name": "Node.js",
"build": {
"dockerfile": "Dockerfile"
},
"remoteUser": "node"
}
11 changes: 11 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"env": {
"browser": true,
"es2021": true
},
"extends": ["eslint:recommended", "prettier"],
"parserOptions": {
"sourceType": "module",
"ecmaVersion": 13
}
}
36 changes: 36 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
##
# @description Release automation
# @author C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
# @link https://semantic-release.gitbook.io/semantic-release/recipes/ci-configurations/github-actions
##
name: Release

on:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: read

jobs:
release:
name : Dispatch release
runs-on: ubuntu-latest

permissions:
contents : write
issues : write
pull-requests: write

steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Generate release
uses: d3p1/semantic-releasify@v1
env :
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
##
# @description Git ignore
# @author C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
##

##
# @note Dependencies
##
node_modules/

##
# @note OS metadata
##
.DS_Store
Thumbs.db

##
# @note IDE files
##
.idea
.vscode
*.code-workspace
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx --no -- commitlint --edit $1
8 changes: 8 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"printWidth": 80,
"semi": false,
"singleQuote": true,
"quoteProps": "consistent",
"bracketSpacing": false,
"arrowParens": "always"
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Cristian Marcelo de Picciotto

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<div align=center>

# [SELF-DRIVING CAR]

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
[![Release](https://github.com/d3p1/self-driving-car/actions/workflows/release.yml/badge.svg)](https://github.com/d3p1/self-driving-car/actions/workflows/release.yml)

</div>

## Introduction

Just studying and practicing my JS skills, implementing a self-driving inspired in this excellent course of [Radu Mariescu-Istodor](https://www.youtube.com/@Radu):

[![Self-driving car - No libraries - JavaScript course](https://img.youtube.com/vi/NkI9ia2cLhc/maxresdefault.jpg)](https://www.youtube.com/watch?v=NkI9ia2cLhc&list=PLB0Tybl0UNfYoJE7ZwsBQoDIG4YN9ptyY)

## Changelog

Detailed changes for each release are documented in [`CHANGELOG.md`](./CHANGELOG.md).

## License

This work is published under [MIT License](./LICENSE).

## Author

Always happy to receive a greeting on:

- [LinkedIn](https://www.linkedin.com/in/cristian-marcelo-de-picciotto/)
- [Web](https://d3p1.dev/)
16 changes: 16 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html>
<!--
/**
* @description Self-Driving Car
* @author C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
*/
-->
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Self-Driving Car</title>
</head>
<body>
</body>
</html>
Loading

0 comments on commit cd66ffa

Please sign in to comment.