Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugorcd/nuxi
Netflix inspired webapp using Nuxt 3
https://github.com/hugorcd/nuxi
boilerplate docker english fench i18n intlify linear mailer nodemailer nuxt nuxt3 pinia scss ssr supabase tailwind tmdb tmdb-api translate
Last synced: 3 months ago
JSON representation
Netflix inspired webapp using Nuxt 3
- Host: GitHub
- URL: https://github.com/hugorcd/nuxi
- Owner: HugoRCD
- License: mit
- Created: 2023-03-02T15:58:46.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T14:56:35.000Z (9 months ago)
- Last Synced: 2024-10-12T05:12:03.146Z (3 months ago)
- Topics: boilerplate, docker, english, fench, i18n, intlify, linear, mailer, nodemailer, nuxt, nuxt3, pinia, scss, ssr, supabase, tailwind, tmdb, tmdb-api, translate
- Language: Vue
- Homepage: https://nuxi-nu.vercel.app
- Size: 9.37 MB
- Stars: 19
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxi
[](https://hugorcd.github.io/nuxi/)
[](https://www.codacy.com/gh/hugoRCD/nuxtjs-boilerplate/dashboard?utm_source=github.com&utm_medium=referral&utm_content=hugoRCD/nuxtjs-boilerplate&utm_campaign=Badge_Grade)
## 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](https://supabase.io/) 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](https://www.docker.com/) 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](https://retype.js.org/) 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](https://nuxtjs.org/) - The Progressive JavaScript Framework
- [Supabase](https://supabase.io/) - Open-Source Firebase alternative
- [Retype](https://retype.js.org/) - The documentation engine
- [pnpm](https://pnpm.js.org/) - Fast and disk space efficient package manager
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details