First project creation

To create a new project, simply enter this command:

This will launch a quick and easy step by step creation process that will ask you for the project name, the recipe to use, etc...

Recipe is the term used in the coffeekraken environment for "project template"

Once this process is done, you can start working on your project. If you choose to not launch the development process at the end of the step by step creation process, simply enter this command:

Start developing

In order to start developing your newly created project, you just need to enter this simple command:

That will launch some processes like:

frontendServer

This server is the main one to access your project. It runs by default on port 8080 for the development environment, and on the port 9090 for the production one.

Note that when we say production for this server, it's just to test your project locally with the production assets (js, css, etc...). This server is not meant to be used as a production one...

Under the hood, our server handles thinks like views compilation (twig, blade, and others to come depending on needs...).

More on this server in the @coffeekraken/s-frontend-server package documentation

vitejs

This server is powered by the AWESOME ViteJs project and is responsible to compile and serve on the fly your assets like javascript and typescript files, css through PostCSS, and more...

We use this package under the hood to add built-in support for things ike PostCSS, Typescript, React, Svelte and more...

Build for production

Each recipes comes with full production ready build stack. To build your project, simply launch thie simply command:

All your productions assets will be stored in the dist folder by default. This can be updated through our configuration system by setting the storage.distRootDir configuration.

Bugs
are not our friends...

Don't hesitate to declare an issue if something does not works as expected.

Declare my issue on Github Talk about it on Discord

The more we are,
the stronger we become.

Don't hesitate to tell some words to you friends about us. The goal is to became more and more each days to help each others...

Support us on Patreon! Share on Facebook! Make a tweet!

The more we are,
the stronger we become.

Don't be afraid to join us on Discord.

Join us on discord!

We love,
Open source!

All of our codebase can be found on Github. We hope that you may contribute to help us make our tools even better!

Discover our codebase!

Welcome on