Code Monkey home page Code Monkey logo

landa's Introduction

LAN.DA

Is a free and open-source starter-kit to make your website using Astro. Ready to start a new project and designed taking into account best practices.

Features

Table of Contents

Demo

๐ŸŒ€ lan-da.vercel.app


Getting started

Project structure

Inside LAN.DA template, you'll see the following folders and files:

/
โ”œโ”€โ”€ data/
โ”œโ”€โ”€ public/
โ”‚   โ””โ”€โ”€ favicon.ico
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ”œโ”€โ”€ images/
|   |   โ””โ”€โ”€ styles/
|   |       โ””โ”€โ”€ base.css
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ core/
|   |   โ””โ”€โ”€ general/
|   |       โ”œโ”€โ”€ Welcome.astro
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   |   |โ”€โ”€ BaseLayout.astro
โ”‚   |   |โ”€โ”€ PageLayout.astro
โ”‚   |   โ””โ”€โ”€ ...
โ”‚   โ”œโ”€โ”€ pages/
โ”‚   |   โ”œโ”€โ”€ index.astro
|   |   โ”œโ”€โ”€ 404.astro
โ”‚   โ”œโ”€โ”€ utils/
โ”‚   โ””โ”€โ”€ config.mjs
โ”œโ”€โ”€ package.json
โ””โ”€โ”€ ...

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory if they do not require any transformation or in the assets/ directory if they are imported directly.


Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:3000
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying

Configuration

Basic configuration file: ./src/config.mjs

export const SITE = {
  name: "Example",

  origin: "https://example.com",
  basePathname: "/", // Change this if you need to deploy to Github Pages

  title: "Example title",
  description: "Example description",
};

Deploy

You can create an optimized production build with:

npm run build

Now, your website is ready to be deployed. All generated files are located at dist folder, which you can deploy the folder to any hosting service you prefer.

Contributing

If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. That would be very useful for all of us and we would be happy to listen and take action.

License

MIT

landa's People

Contributors

alandawi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.