Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Readme.md and .env.example file for security #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
IPFS_JWT=your_ipfs_jwt_here
BACKEND_URL=your_backend_url
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ logs
.idea

# Local env files
.env.*
.env
!.env.example
69 changes: 59 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
# Nuxt 3 Minimal Starter

Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
This is a minimal Nuxt 3 starter project. It includes everything you need to quickly get started with your Nuxt 3 application.

## Setup
For detailed instructions, refer to the official [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction).

Make sure to install the dependencies:
## Features
- 🚀 **Fast & minimal** Nuxt 3 setup
- 🎯 TypeScript support
- 📦 Vite as the default build tool
- 🔥 Hot Module Replacement (HMR)

---

## Getting Started

### Prerequisites
Ensure you have [Node.js](https://nodejs.org/en/) installed (version 16 or higher is recommended).

### Setup

Install the dependencies using your preferred package manager:

```bash
# npm
Expand All @@ -17,9 +32,9 @@ pnpm install
yarn install
```

## Development Server
### Development Server

Start the development server on `http://localhost:3000`:
Start the development server locally at `http://localhost:3000`:

```bash
# npm
Expand All @@ -32,11 +47,13 @@ pnpm run dev
yarn dev
```

## Production
Nuxt provides hot reloading, so changes will be reflected immediately without restarting the server.

Build the application for production:
## Build for Production

```bash
Build the application for production use:

``bash
# npm
npm run build

Expand All @@ -47,7 +64,7 @@ pnpm run build
yarn build
```

Locally preview production build:
Once built, you can locally preview the production build using:

```bash
# npm
Expand All @@ -58,6 +75,38 @@ pnpm run preview

# yarn
yarn preview

```
### Lint & Format Code

To keep your code clean and consistent, you can run linting and formatting checks:

```bash
# Lint
npm run lint

# Format
npm run format
```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
## Deployment

After building, you can deploy the `dist/` directory to any static hosting service. For more detailed deployment steps, refer to the [Nuxt 3 deployment documentation](https://nuxt.com/docs/getting-started/deployment).

## Useful Resources

[Nuxt 3 Documentation](https://nuxt.com/docs/getting-started/introduction)
[Nuxt 3 GitHub Repository](https://github.com/nuxt/nuxt)
[Nuxt 3 Configuration Reference]()

## Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue to help improve this project.

## License

This project is licensed under the MIT License. See the [LICENSE]() file for details.

---

By making these additions and improvements, the README is now more structured, informative, and aligned with common open-source practices.