chocolat-chaud-io / stator Goto Github PK

• Add CI which builds and fails if linting failed
• Implement test coverage and CI artifacts
• Enforce file naming conventions
• Enforce branch naming convention
• Make sure eslint works
• Enforce commit convention with semantic release
• Make sure commit messages are respected with commitizen
• Add badges
• Auto deploy webapp, backend and database with netlify or digital ocean

• Add a link to app platform apps after deployment
• Move NX steps 10-11-12 to [PUBLIC REPOSITORY ONLY]
• Detect OS windows messages as part of the steps

• Auto deploy when a pull request is merged on master using Github Actions (if possible only affected apps)
• Implement automatic scaling which can be configured through code/config file
• Deploy self contained review apps on pull requests
• Update the readme to reflect the new steps needed when using this project as a template

I was thinking maybe we could use Kubernetes, but one thing I don't like about it is the complexity which is often way too high for simple projects. Since this is a template project, make it as simple as possible with detailed instructions. We can use other tools if we see fit.

• Mention that it's full-stack and list all the technologies used

Currently, we need to read too many texts in order to get started. This is not acceptable as the goal of this project is to make the process stupid simple. An interactive CLI could be a great idea.

• Add step in NX cloud CLI setup to install NX globally (or maybe use npx)
• Add step in digital ocean that tells the user to run this command: doctl apps create --spec .do/app.yaml
• Rename run commands from npm run api to npm start api and same thing for webapp

• Investigate which makes sense for us and add them. -> https://github.com/nestjsx/crud
• Add renovate bot

This action allow auto-merge of pull requests when they are ready. Add the required configurations and implement it in stator.

• Update readme
• Delete npm package-lock.json

https://github.com/evanw/esbuild can dramatically speed up build time

• Investigate if it's compatible
• Implement if it is
• Update readme accordingly

Parallel execution can be enabled with the --parallel flag

If successful, you shouldn't see any warnings in the CI.

https://github.com/juliandavidmr/awesome-nestjs#components--libraries

This will produce better documentation. The Webpack config from the API must be enhanced with the swagger plugin.

https://resources.whitesourcesoftware.com/news-whitesource/merge-confidence-feature

network_mode: host isn't compatible with OSX. Use alternatives such as Docker linking.

• Update package.json to allow node v14.x only
• Update readme prerequisites

• Generate a frontend app named webapp using NX
• Integrate a UI framework
• Implement the best store system you can find
• Implement a simple todo application with CRUD operations
• Integrate the backend once it is ready
• Implement end to end tests using cypress

Following a conversation with nightowl_games from hacker news, I think this readme's section could be improved to fully grasp the intent of this project, what it actually is, and how it can be used.

Namecheap link

General links currently to global, instead of general

Before getting started let's communicate what's the vision for this project.

What's the purpose of this project?

Stator will be a highly opinionated tool to facilitate getting started with new projects by deciding for you what the perfect modern stack looks like.
It will be able to generate top level mono repository project as well as it's underlying packages such as web application, backend, database, etc.

How will the program be executed?

This will be a CLI tool that can be installed globally or as development dependency from the npm package registry.

What will stator be able to generate for v0

• Root project will be using lerna, prettier, tslint, readme with starting instructions
• Web application will be using react, redux (or other), bundler, typescript, test-framework (with code coverage), vscode config file
• Backend will be using node, typescript, express (or other), hot-reload, test-framework (with code coverage), vscode config file
• Database will be using mongodb

How will we generate those components?

We will be using a templating system named mustache

• Use ts-node to run the files.
• Update anything that was previously using those files (scripts, readme?, etc...)

• Have the ability to view and filter logs from an URL (check if DigitalOcean have a solution for this)
• Replace existing console.xxx with the logger implementation
• Update get-started CLI accordingly (should be an optional step for the online saving part)
• Ensure the logger works even if the online part isn't configured
• Update README.md

Organize readme so it's easier to read. Experiment with different ideas to improve readability.

Implement server side caching with a tool like redis.

Comes from #102 and #103

• Transform the code coverage setup into choosable list

• Create a docker-compose file with frontend, backend, database
• Automatically generate droplets on digital ocean and run the docker-compose if non exists with the PR number
• Ensure application is available to the external world
• Add a link in the pull request with the newly hosted app URL
• When the pull request is deleted make sure the droplet is deleted too
• Write documentation concerning the review apps in the readme
• Ensure updating a PR update the review app
• Optimize CI pipeline
• Add support for https
• Ensure review apps are not created for renovate bot PRs

• Ensure both of those scripts still work
• Remove console.log from enforce-file-folder...

Instead of basing any affected changes from master, we should use github ${{ github.event.pull_request.base.sha }} and ${{ github.event.pull_request.head.sha }} as done like this open source action.

nx affected:build --base=${{ github.event.pull_request.base.sha }} --head=${{ github.event.pull_request.head.sha }}

Also, we should then remove the following command, as it becomes useless:

- name: Fetch latest changes
  run: git fetch --no-tags --prune --depth=5 origin master

• Move import-sort to dev dependencies
• Run linting and enforce-file-folder-naming-convention.js on hook
• Make sure all those conventions are explained in the readme

This will help speed up the feedback loop for developers instead of having to wait for the CI to tell them.

Hey @yann510 !

Thank you so much for this amazing template. It's helped me learn so much about best practices for building a full stack app <3

Just had a quick question that I've been hitting my head on. What's your go-to for managing env variables in Stator? I tried cloning, running npm run gen-started and deploying via Digital Ocean but hit an error about the database env variables not being defined (like database.HOSTNAME).

Sorry if this is kind of a noob question 😅

• Add support for migrations with an example
• Update the README

Right now, the script raplaces all occurences of stator, but it should also be possible to pass the repository own/organization name, to remove, in this case, chocolat-chaud-io

• Add this option in the deployment section of the CLI

The previous implementation did not work with decorators. To fix the issue, run npm install --dev import-sort-style-module. You can choose styles from https://github.com/renke/import-sort/tree/master/packages