Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nroh555 authored Jun 8, 2024
1 parent b58807a commit 6e3288e
Showing 1 changed file with 16 additions and 25 deletions.
41 changes: 16 additions & 25 deletions strapi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
# 🚀 Getting started with Strapi

Strapi comes with a full featured [Command Line Interface](https://docs.strapi.io/dev-docs/cli) (CLI) which lets you scaffold and manage your project in seconds.
### How To Run
In order to run Strapi locally, there are a few things you need to setup first. Strapi is connected to a postgres database to store the data and hence a postgres database needs to be provisioned. Follow the commands below to get started

```bash
cd postgres
```
```bash
docker compose up
```

Then on another terminal
```bash
yarn develop
```

That is it. You should be good to go to use Strapi and Postgres locally to develop your application

### `develop`

Expand Down Expand Up @@ -31,27 +46,3 @@ npm run build
# or
yarn build
```

## ⚙️ Deployment

Strapi gives you many possible deployment options for your project including [Strapi Cloud](https://cloud.strapi.io). Browse the [deployment section of the documentation](https://docs.strapi.io/dev-docs/deployment) to find the best solution for your use case.

## 📚 Learn more

- [Resource center](https://strapi.io/resource-center) - Strapi resource center.
- [Strapi documentation](https://docs.strapi.io) - Official Strapi documentation.
- [Strapi tutorials](https://strapi.io/tutorials) - List of tutorials made by the core team and the community.
- [Strapi blog](https://strapi.io/blog) - Official Strapi blog containing articles made by the Strapi team and the community.
- [Changelog](https://strapi.io/changelog) - Find out about the Strapi product updates, new features and general improvements.

Feel free to check out the [Strapi GitHub repository](https://github.com/strapi/strapi). Your feedback and contributions are welcome!

## ✨ Community

- [Discord](https://discord.strapi.io) - Come chat with the Strapi community including the core team.
- [Forum](https://forum.strapi.io/) - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.
- [Awesome Strapi](https://github.com/strapi/awesome-strapi) - A curated list of awesome things related to Strapi.

---

<sub>🤫 Psst! [Strapi is hiring](https://strapi.io/careers).</sub>

0 comments on commit 6e3288e

Please sign in to comment.