Code Monkey home page Code Monkey logo

yago-nuxt's Introduction

Yago-Nuxt

This repository contains the source code for the yago-nuxt project for the hackathon. This repository use mainly these technologies:

Nuxt Vite Typescript Tailwind Github Actions

Set up the project

ASDF

At the root of the repository, there is a file called .tool-versions. This file contains the version of the tools used in the project. You can use ASDF to install the right version of the tools.

First, install all the required plugins for ASDF:

cut -d' ' -f1 .tool-versions | xargs -i asdf plugin add  {} 

Then, you can do the following command to install all the tools with the right version:

asdf install

After that, install the dependencies:

pnpm install

You're ready to go! ๐Ÿš€

Docker

You can also use Docker to run the project. You need to have Docker installed on your machine. Then, you can run the following command to build the image:

docker compose up --build

All the dependencies will be installed and the project will start automatically! ๐Ÿš€

Available commands

  • pnpm run build: Build the project using Vite, nuxt will creates a .output directory with all the application, server and dependencies ready for production.
  • pnpm run dev: Start the project in development mode.
  • pnpm run generate: Pre-renders every route of application and stores the result in plain HTML files that can deploy on any static hosting services.
  • pnpm run preview: Start a server to preview your Nuxt application after running the build command.
  • pnpm run postinstall: Run automatically after the installation of dependencies for generating type definitions for the project into the .nuxt folder.
  • pnpm run lint: Show and try to correct some error in the code using ESLint.
  • pnpm run format: Format automatically the code using Prettier.
  • pnpm run typecheck: Check the validity of Typescript types of the code using vue-tsc.
  • pnpm run lint:all: Execute lint, format, and typecheck commands.

You can run directly these command with your IDE in package.json file.

yago-nuxt's People

Contributors

sirmishaa 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.