Full-stack boilerplate (project/hackathon starter) with Docker/NodeJS/Typescript/GraphQL/React/Material-UI
The above libraries and frameworks are the best ones (in my opinion, of course) regarding my desires at the moment of starting this project.
It's just a simple (albeit huge) coincidence that 3 of them sound NEX-ish. It would've been a shame not to name the stack similarly.
I wanted a NodeJS/Typescript based stack that would: * Help me develop web apps as fast as possible * With the cool javascript technologies of the moment (the "moment" is 2020 - most probably a small part of 2020): Typescript, React with typescript and hooks, GraphQL, Material-UI. * While following as much as possible the good ideas from the NodeJS best practices.
If interested, read about the whys and the objectives of the Knests Stack on my blog.
It contains the free admin dashboard theme from devias.io.
cdinto it
Only needed to be run first time:
$ docker network create traefik-public $ docker network create knests-dev
`rm -rf client/dist && docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --build -V --force-recreate`
Note: The
rm -rf client/distpart is needed (for now, until we have a better solution) for deleting the files nextjs generates.
Go to http://localhost:8080/api/migrate to have the latest migrations applied. Go to http://localhost:8080/signup and create your first user.
Search and replace
knestswith your own project name and you'll have a project with: *
/signuppage and functionality *
/loginpage and functionality *
/admin/dashboardbasic page, taken from devias.io
rm -rf client/dist/ && docker-compose -f docker-compose.yml -f docker-compose.dev.yml run --service-ports postgres- make sure you expose the service ports to the host using the ports directive
There are moments in the dev/test flow when the docker images need to be rebuilt (after installing new packages for example). AAdding the
--buildparameter to the docker-compose command will usually be enough. For example:
rm -rf client/dist/ && time docker-compose -f docker-compose.yml -f docker-compose.test.yml up --build --abort-on-container-exit --renew-anon-volumes --force-recreate
When that's not enough, try one of the things below.
Docker can be surprising at caching stuff. Caching anonymous volumes was totally unexpected for me.
Read the docs of all the commands that you intend to run on your systems, because these can and will have side effects on your systems!
Here are some commands that clear all kind of caches:
docker system prune- this might take a while, because it says it clears everything.
docker rmi $(docker image ls -a)- tries to remove all the local images.
There is some frontend / backend documentation written so you can debug things more thoroughly when they don't go as expected.
[] Fullstack e2e testing using Playwright and code coverage generating for both UI and server. [] Create tutorials documenting the development flow using the Knests stack. [] Since this is hosted on Github, migrate the Gitlab CI/CD pipeline to Github actions and dockerhub registry. [] Deployment and hosting on Kubernetes (?) [] Internationalization (?) [] Other good ideas