Skip to content

Latest commit

 

History

History
127 lines (84 loc) · 4.78 KB

README.md

File metadata and controls

127 lines (84 loc) · 4.78 KB
Raw

🚀 Aggregated Public Information

This project uses Strapi as a CMS backend.

Dev Environment Setup

Local Development 🏠

If you'd like to develop locally, follow these steps. Otherwise, you can skip to Gitpod development below.

1. Clone this repository

git clone [email protected]:distributeaid/aggregated-public-information.git
cd aggregated-public-information

2. Install nvm 🔧

To develop or contribute to this project, you will need Node.js. We recommend you install Node Version Manager (nvm) to manage Node.js versions.

3. Install yarn 🧶

To build dependencies, you should also have yarn installed on your system. If it is not yet installed, you can run:

npm install --global corepack
corepack enable
hash -r

Gitpod Development ☁️

If you'd prefer to develop on the cloud, Gitpod provides a fully automated development environment for this Strapi project, and the development environment is set up with just a single click. If you'd prefer to use Gitpod, follow these steps to get started:

Open in Gitpod

  1. Click the Open in Gitpod button above. Note: you'll need to have an account on Gitpod before proceeding with the next steps (this requires a GitHub account).
  2. Click the Continue button.
  3. Relax, a development environment is being set up for you in the first terminal.

Note

To access your workspace later, go to Gitpod Workspaces. Pin the aggregated-public-information workspace to prevent auto-deletion after 14 days by clicking the three dots next to the workspace name and selecting "Pin".

Get Up and Running 🚀

Once you have a development environment, you can set up your local site!

1. Set Up Local Private Keys 🔑

./setup.bash

2. Install your packages

yarn

3. Start Your Server 🌐

In one terminal, run develop, this will live rebuild your application as you make changes:

yarn develop

If you want autoreload disabled, you can just run build and then start:

yarn build
yarn start

4. Run Tests ✅

yarn test

Note

This depends on your application being built! If you don't run yarn develop then you must run yarn build after each change before running yarn test. We have provided yarn test:with-build as a convenience in this case.

5. View the Site and Set Up an Admin User 👤

If you are running locally, your site should be available in the output after you run yarn develop - you will see something like

One more thing...
Create your first administrator 💻 by going to the administration panel at:
┌─────────────────────────────┐
│ http://localhost:1337/admin │
└─────────────────────────────┘

To access the your deployment on Gitpod, you will have to confirm the message that pops up telling you where to access it. You can see your open ports with

gp ports list

Learn more 📚

Distribute Aid 🌍

Strapi

  • Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.
  • Resource center - Strapi resource center.
  • Strapi documentation - Official Strapi documentation.
  • Strapi tutorials - List of tutorials made by the core team and the community.
  • Strapi blog - Official Strapi blog containing articles made by the Strapi team and the community.
  • Changelog - Find out about the Strapi product updates, new features and general improvements.

Feel free to check out the Strapi GitHub repository. Your feedback and contributions are welcome!

✨ Community

  • Discord - Come chat with the Strapi community including the core team.
  • Forum - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.
  • Awesome Strapi - A curated list of awesome things related to Strapi.