Skip to content

RedCrafter07/retmod

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Retmod

Retmod is a web development stack including

Why?

I was tired having to build a web application with NextJS or similar, which are great frameworks, but they were missing something I was experienced with - express. That's why I created Retmod. It combines all of that into a single application. Means no two seperate servers running.

How does Retmod work?

Bridge

In the root of your repository, you have a package json with scripts. This place is called the bridge, as it is the place where all processes are started from. The install command automatically installs all dependencies in the client and server directory too. Using concurrently, server and client process can run at the same time without having problems.

Client Process

The client process is just Webpack running in dev mode. Simple, right?

Server Process

The server process is another concurrently instance running typescript in watch mode and nodemon. After typescript detects changes, it will compile everything to JavaScript files and then trigger nodemon to restart the server.

Requirements

You need to have a working node.js installation, as well as git and pnpm.

Getting started

To get started, get the retmod-cli. It's a simple command line tool that will get stuff done for you.

Info

Retmod is developed using pnpm. That's why it's recommended to use it. You can install this package manager with the following command:

npm i -g pnpm

Other methods can be viewed here

Install the CLI with the following command:

pnpm add -g retmod-cli

Then, run the retmod command and chose "Create a new project". Simple, right? Retmod will prompt you about needed information.

Templates

Retmod comes with a few templates. You can view them here: https://github.com/Retmod/templates

Building

If you want to build the application for production, use Docker:

docker build -t <your-image-name> .

Other methods are possible, but not really supported. However, that doesn't mean you can't use other methods.

If you like Retmod, consider starring it. Thanks! :)