Server Starter Folder

Are you tired of always creating the same structure from scratch for your projects? Me too.

This is my go-to when I start a new project on backend-end development.

If you found it useful somehow, I would be grateful if you could leave a star in the project's GitHub repository This repository contains a basic file structure and configuration for starting a new server-side project. It includes the following:

config: A directory for storing configuration files, such as environment variables.
src: A directory for storing the main source code of the project.
test: A directory for storing test files.

Documentation

This project uses the airbnb JavaScript style guide for linting with ESLint.

Roadmap

• degit a-s-t-e-y-a/server_starter_folder <folder_name>

• cd <folder_name>

• yarn

• npm start

• npm test

if you are going to use yarn

see this

🔮 What’s inside?

• 💅 Prettier - Opinionated Code Formatter.
• 🔍 ESLint - Tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
• 🐶 Husky - Git hooks made easy.
  • 🪝 commit-msg
  • 🪝 pre-commit
• 🚫 Lint Staged - Run linters on git staged files.
• ✍️ Conventional Commits with 🎉 Gitmoji - A specification for adding human and machine readable meaning to commit messages.

🚀 Getting Started

These are the necessary steps to use 💯 of the potential of this boilerplate.

🚨 Prerequisites

You need this technologies :

• Node 16>=
• Git
• Gitmoji CLI

👇 Creating a commit as an example

I will add the gif very soon

📜 Conventional Commit Rules

Use this table as a reference when writing commits. Husky will be in charge of checking that the rules will be followed.

Commit Type	Title	Description	Emoji
feat	Features	A new feature	✨
fix	Bug Fixes	A bug fix	🐛
docs	Documentation	Documentation only changes	📝
style	Styles	Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)	🎨
refactor	Code Refactoring	A code change that neither fixes a bug nor adds a feature	♻️
perf	Performance Improvements	A code change that improves performance	⚡
test	Tests	Adding missing tests or correcting existing tests	✅
build	Builds	Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)	🚨
ci	Continuous Integrations	Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)	👷
chore	Chores	Other changes that don't modify src or test files	➕
revert	Reverts	Reverts a previous commit	⏪

Additional Information

Feel free to customize this starter folder to fit the needs of your project.

If you have any questions or issues, please open an issue on the GitHub repository.

Author

krishna seth