Last updated on 12/8/2024
Getting Started with NextPress
Welcome to NextPress! This guide will walk you through the essential steps to get your project up and running.
Prerequisites
Before you begin, make sure you have the following installed:
Setup Instructions
1. Clone the Repository
Start by cloning the project repository:
git clone https://github.com/your-repo/your-project.git
cd your-project
2. Install Dependencies
Install the required dependencies with either npm or Yarn:
With npm
npm install
Or with Yarn
yarn install
3. Configure Environment Variables
Create a .env file in the root of your project:
cp .env.example .env
The defaults here will use the included dockerfile provided images
4. Set Up Prisma
Run Migrations Apply database migrations:
npx prisma migrate dev --name init
This will set up your database tables based on the schema.prisma file.
Verify Prisma Setup You can visualize your database schema with the Prisma Studio:
npx prisma studio
5. Start the Development Server
Run the development server:
npm run dev
Visit http://localhost:3000 in your browser to see your application.
6. Commands
Here are some useful commands for working with the project:
- Start Development Server:
npm run dev
- Build for Production:
npm run build
- Run Migrations:
npx prisma migrate dev
- Generate Prisma Client:
npx prisma generate
- Open Prisma Studio:
npx prisma studio
7. Deploying Your Project
Build your project for production:
npm run build
Use a deployment platform like Vercel or Netlify.
You will also need a database server, such as Neon
Follow the respective platform's instructions for deploying a Next.js project.
Learn More
To learn more about the tools used in this project, check out the following resources:
Happy coding! 🎉