Skip to content

EmerikC/nextjs-dashboard

Repository files navigation

Next.js Dashboard

A modern dashboard web application built with Next.js, React, Tailwind CSS, and NextAuth.js.


🚀 Getting Started

1. Clone the repository

git clone https://github.com/your-username/nextjs-dashboard.git
cd nextjs-dashboard

2. Install dependencies

npm install

3. Set up environment variables

Create a .env.local file in the root directory and add your environment variables as needed.
Example:

DATABASE_URL=your_database_url
NEXTAUTH_SECRET=your_nextauth_secret
# Add other variables as required

4. Run the development server

npm run dev

Open http://localhost:3000 to view the app.


📦 Available Scripts

  • npm run dev — Start the development server
  • npm run build — Build the app for production
  • npm run start — Start the production server
  • npm run lint — Run ESLint to check for code issues

📝 Notes

  • Use npm for installing dependencies and running scripts.
  • Do not commit node_modules or any lock files other than package-lock.json.
  • Environment variables should be stored in .env.local (not committed).
  • For deployment, follow your hosting provider’s Next.js instructions (e.g., Vercel).

🤝 Contributing

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Commit your changes
  4. Push to your branch (git push origin feature/your-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT

Releases

No releases published

Packages

No packages published

Languages