Are you tired of spending endless hours structuring your ExpressJS projects from scratch? Say goodbye to the hassle and welcome a game-changing solution! Introducing GenEx, a powerful and small PowerShell script designed to streamline your project setup process and elevate your development experience to new heights.
With GenEx, you can bid farewell to the tedious manual creation of project structures. Inspired by the convenience of popular tools like CRA (create-react-app) and Vite, this innovative script empowers you to effortlessly generate an efficient folder structure for your small, medium, or even large-scale applications. It also provides you with essential packages (listed below), including MySQL/Knex library
No more wasting precious time on mundane project structuring tasks! GenEx automates the process, allowing you to kickstart your projects in seconds. Focus on what truly matters—building exceptional applications.
A well-thought-out folder structure that caters to the unique needs of ExpressJS applications. It ensures a logical organization of files, making it a breeze to navigate and maintain your codebase. Say goodbye to chaos and welcome order!
- express
- axios
- bcrypt
- cors
- dotenv
- jsonwebtoken
- knex
- mysql
- multer
- node-cron
- nodemon
- uuid
- nodemailer
- typescript (if selected TypeScript)
- ts-node (if selected TypeScript)
- Rapidly create an optimal folder structure for your ExpressJS projects
- Tailored for small to medium and potentially large-scale applications
- Intuitive and easy-to-use script for developers of all levels
- MySQL/Knex is set for your configuration
- git initialized by default
- JWT setup with a random string generated from crypto library in .env file
- and other boilerplates!
Don't let tedious project setup slow you down. Supercharge your ExpressJS development process with ExpressJS Project Structurer and witness a new era of efficiency and quality. Get started today and revolutionize the way you build exceptional applications! ✨
0. Must haves
Node
Knex (globally installed)
Powershell
1. Open PowerShell and clone the repo
$ git clone https://github.com/NB071/GenEx
2. Navigate to the project's folder
$ cd GenEx
3. Check and modify your execution policy if needed
$ Get-ExecutionPolicy
it should be `RemoteSigned`
if it's not, change it:
$ Set-ExecutionPolicy <Unrestricted/RemoteSigned>
You could run the script now. However, for later uses, I recommend creating an alias (depending on your OS and shell you are currently using)
$ <script> [-d/-dir/-directory] <PROJECT'S_FOLDER_NAME> [-t/-temp/-template] <Extension type: js | ts>
$ ./genEx.ps1 -d example -t ts
TIP: the extension type is optional, and the default creates js files
TIP: if you're in a rush, you can run only:
$ <script> <PROJECT'S_FOLDER_NAME> <Extension type: js | ts>
$ ./genEx.ps1 example ts
1. setup your db
2. setup your environment variables
3. customize the structure if needed
4. develop your application
5. connect your repo
6. edit README.md
1. Fork the repository.
2. Create a new branch: git checkout -b feature-name
3. Make your changes.
4. Commit your changes: git commit -m 'Add some feature'
5. Push to the branch: git push origin feature-name
6. Submit a pull request
I warmly welcome any ideas and feedback from all!
This script is open-source and initially developed for my personal use. Its purpose is only to create files and folders. There is no malicious activity involved in any part of this script!
Powershell