Project template

Project description TBA...

🔗 Table of Content

Technology stack
Prerequisites
Getting started
Contributing
Feedback
Security Policy
License
Contact

💻 Technology stack

This project uses the following technology stack, and there's short reasoning as to why these choices.

Git

As a core version control tool, because it can be used with GitHub or GitLab.

Node.js

As JavaScript runtime for this project development.

TypeScript

As the primary programming language because it offers fantastic developer experience thanks to its toolings, typings and helps find possible bugs.

Vite

As a JavaScript bundler, because it is speedy for local development and supports modern technologies.

PostCSS

For using the modern CSS features and plugins to improve the development flow, such as autoprefixer.

Sass

As the primary CSS language, for improving the development experience with advanced syntax.

Jest & Testing Library

As a JavaScript Testing Framework because it focuses on simplicity, also it is utilized with Testing Library for the good testing practices.

⚓ Prerequisites

This project requires these tools to be able to run it locally on your device and develop.

Git version control tool to be installed.
Latest Node.js LTS (Long-Term Support) version.
pnpm - as Node.js package manager.
Other package managers such as npm or yarn may work; however this project setup is optimized for pnpm.

🏁 Getting started

The following steps are supposed to help you run this project locally (on your current device on your network).

Clone this project with Git using the following command:

git clone https://github.com/xeho91/project-template.git

Install all of the dependencies (Node.js packages) by typing in your terminal:
```
pnpm install
```
Configure the Environment Variables based on the .env.example file.

📝 NOTE: You can either create a local .env file or use Doppler.
Build the output and preview it using the command:
```
pnpm start
```
Go to http://localhost:5000/ page in your browser.

NOTE: If you want to open it on other devices on your network, use the IP address provided in the terminal output after running the script.

⚙️ Contributing

Please take a look at the CONTRIBUTING.md file, where the development flow is explained and thoroughly described.

🔄 Feedback

Have you found a bug?
Would you mind not hesitating to open an issue if you have time?

Did you notice bad UX practice(s)?
Please get in touch with me or open an issue. I am constantly learning, and I treat it seriously. So I would appreciate the effort. To save your time, you can also provide a link to a resource to learn more about it.

Have you noticed any a11y issue(s)?
Please let me know immediately! I care a lot about it.

🔒 Security Policy

For more information about the Security Policy, take a look at the SECURITY.md file.

⚖️ License

The code is licensed under the MIT license.

The graphical assets created by me are licensed under CC BY-SA 4.0.
There's a more human-readable summary of this license.

✉️ Contact

You can contact me through:

my website contact subpage
Twitter DM (Direct Messages)
Polywork
Keybase

xeho91 / project-template-old