This starter can be used to run Next.js using Docker in 🤗 Spaces.

1. Install the dependencies: npm i
2. Start the local dev-server: npm run dev
3. Open the app via localhost:3000

To make sure that everything is working out, you can run your container locally:

1. Install Docker on your machine
2. Go into the nextjs-docker-starter folder
3. Build your Docker image: docker build -t nextjs-docker-starter ..
4. Run your Docker container: docker run -p 3000:3000 nextjs-docker-starter.
5. Open the app via localhost:3000

To add support for Docker to an existing project, just copy the Dockerfile into the root of the project and add the following to the next.config.js file:

// next.config.js module.exports = { // ... rest of the configuration. output: "standalone", };

This will build the project as a standalone app inside the Docker image.

If you want to use all the features for collaborative development on GitHub, but keep your demo on Spaces, then you can set up a GitHub action that will automatically push changes from GitHub into Spaces.

ℹ️ Git-LFS is required for files bigger than 10MB

1. Create your repo on GitHub
2. Create a Github secret named HF_TOKEN and use an access token from Hugging Face as its value (you must be logged in to do this)
3. Update the workflow sync_to_hf_spaces.yml
   • Configure HF_USERNAME: Replace failfast with the name of your 🤗 user account or your 🤗 organization
   • Configure HF_SPACE_NAME: Replace nextjs-docker-starter with the name of your 🤗 space
4. Push the code into your repo on GitHub

This should force push changes in the main branch from GitHub into your 🤗 space.

For further information, you can check out the guide on Hugging Face.