This is the API for Marco Polo.
To spin up the project locally, follow these steps:
- First clone the repo
- Then
cd YOUR_PROJECT_REPO && cp .env.example .env
- Next
npm && npm dev
(ordocker-compose up
, see Docker) - Now
open http://localhost:3000/admin
to access the admin panel - Create your first admin user using the form on the page
That's it! Changes made in ./src
will be reflected in your app.
Alternatively, you can use Docker to spin up this project locally. To do so, follow these steps:
- Follow steps 1 and 2 from above, the docker-compose file will automatically use the
.env
file in your project root - Next run
docker-compose up
- Follow steps 4 and 5 from above to login and create your first admin user
That's it! The Docker instance will help you get up and running quickly while also standardizing the development environment across your teams.
To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:
- First invoke the
payload build
script by runningnpm build
ornpm run build
in your project root. This creates a./build
directory with a production-ready admin bundle. - Then run
npm serve
ornpm run serve
to run Node in production and serve Payload from the./build
directory.