Skip to content

sergio-ridaura/kickstart-template

Repository files navigation

Kickstart template v1.9.1

Copyright (c) 2024 Sergio Ridaura.

Description

Kickstart template for my website developments.

TypeScript AssemblyScript Astro React Tailwind Node MySQL

Template developed with Astro, featuring static rendering (SSG), client-side rendering (CSR), and server-side rendering (SSR), with integration of TypeScript, Tailwind CSS, React.js, Node.js, MySQL and AssemblyScript.

For versatile development of a wide range of websites and web applications, including blogs, landing pages, informational sites, portfolios, social networks, e-commerce, web games, command-line applications (CLI), export modules, REST APIs, among others.

New Project

Clone the project with Git or use GitHub with this template.

git clone https://github.com/sergio-ridaura/kickstart-template

Adapt the README.md, LICENSE, docker-compose.yml, package.json, .env and .env.prod files to your needs.

Start the container with Docker Compose.

docker-compose up -d

Access the Node.js container. For example:

docker exec -it kickstart-templete_node bash

Update Npm and Node.js.

npm update -g npm
npm install -g n
n lts

Add project dependencies.

npm install

If necessary, repair the user's permissions.

sudo chown -R $USER .

Develop

Development command.

npm run dev

Visit the page http://localhost:4321/ to see the result.

Preview

Build the application.

npm run build:local

Run the built application.

npm run preview

Visit the page https://localhost/ to see the result.

Deploy in server

Clone the project with Git, for example:

git clone https://github.com/sergio-ridaura/kickstart-template

Update Npm and Node.js.

npm update -g npm
npm install -g n
n lts

Add project dependencies.

npm install

Adapt the .env and .env.prod file to your site.

PUBLIC_SITE=https://localhost
PUBLIC_DOMAIN=localhost
PUBLIC_ADAPTER=server

Build the application.

npm run build

Run the built application.

npm run start

Visit the page to see the result, for example: http://localhost/.

Deploy in Netlify

Adapt the .env and .env.prod file to your site.

PUBLIC_SITE=https://kickstart-template-demo.netlify.app
PUBLIC_DOMAIN=kickstart-template-demo.netlify.app
PUBLIC_ADAPTER=netlify

Private environment variables must be managed from the Netlity tools.

Deploy in Vercel

Adapt the .env and .env.prod file to your site.

PUBLIC_SITE=https://kickstart-template-demo.vercel.app/
PUBLIC_DOMAIN=kickstart-template-demo.vercel.app
PUBLIC_ADAPTER=vercel

Private environment variables must be managed from the Vercel tools.

Author

Full stack developer: TypeScript, AssemblyScript, Astro, React, Tailwind, Node and MySQL.

TypeScript AssemblyScript Astro React Tailwind Node MySQL

Fast development of high-performance web applications and sites.

Email GitHub LinkedIn

MIT License

Copyright (c) 2024 Sergio Ridaura.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.