39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
# Payload Personal Portfolio
|
|
|
|
### Development
|
|
|
|
1. `cp .env.example .env` to copy the example environment variables.
|
|
2. `npm install && npm run dev` to install dependencies and start the dev server
|
|
3. open `http://localhost:{process.env.PORT}` to open the app in your browser
|
|
|
|
|
|
## How it works
|
|
|
|
The Payload config is tailored specifically to the needs of most websites. It is pre-configured in the following ways:
|
|
|
|
### Collections
|
|
|
|
See the [Collections](https://payloadcms.com/docs/configuration/collections) docs for details on how to extend this functionality.
|
|
|
|
- #### Users (Authentication)
|
|
|
|
Users are auth-enabled collections that have access to the admin panel.
|
|
|
|
For additional help, see the official [Auth Example](https://github.com/payloadcms/payload/tree/main/examples/auth) or the [Authentication](https://payloadcms.com/docs/authentication/overview#authentication-overview) docs.
|
|
|
|
- #### Media
|
|
|
|
This is the uploads enabled collection. It features pre-configured sizes, focal point and manual resizing to help you manage your pictures.
|
|
|
|
### Docker
|
|
|
|
Alternatively, you can use [Docker](https://www.docker.com) to spin up this template locally. To do so, follow these steps:
|
|
|
|
1. Follow [steps 1 and 2 from above](#development), the docker-compose file will automatically use the `.env` file in your project root
|
|
1. Next run `docker-compose up`
|
|
1. Follow [steps 4 and 5 from above](#development) 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.
|
|
|
|
|