Nuxi

Features

Authentication

• OAuth authentication with multiple providers such as Google, GitHub, etc...
• Working forgot password feature

UI/UX

• Translation with I18n for multiple languages support
• Dark and light theme switchable by the user
• Fully responsive design using SCSS
• Admin Dashboard

API

• Use Supabase for real-time and powerful API
• Easy and secure way to connect your frontend to your database
• There is also a self api inside using the Nitro server built-in Nuxt

Deployment

• Include Docker configuration using a Dockerfile and Docker-compose
• Easily deploy the application in a container running on port 8080
• simply run docker-compose up to start the application

Documentation

• Use Retype for documentation
• Automatic generation of documentation from your code

Lint

• Eslint is configure on the boilerplate (configure for Typescript, with Prettier)

Console

This application includes a powerful console that can be launched by using the shortcut cmd + k. This console can provide various features to facilitate development and management of the application but you will need to develop your own commands. the console in the boilerplate is just an example of what you can do with it.

Contact

The contact page is connect with a linear team to track ticket

Mailer

A Nodemailer is connected to send every kind of mail (forgot-password, new-user, etc...)

Getting Started

Clone the repository:

git clone [email protected]:hugoRCD/nuxi

Install dependencies:

pnpm install

There is no need to use the --shamefully-hoist flag here because the dependencies the flag is set to true by default in the .npmrc file.

Start the development server:

pnpm dev

Now you can open the app in your browser at http://localhost:3000 if you do not override the default port.

Start the documentation

retype watch

You can access the live documentation at https://hugorcd.github.io/nuxi/

Built With

• Nuxt.js - The Progressive JavaScript Framework
• Supabase - Open-Source Firebase alternative
• Retype - The documentation engine
• pnpm - Fast and disk space efficient package manager

License

This project is licensed under the MIT License - see the LICENSE file for details