Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 3.21 KB

README.md

File metadata and controls

87 lines (62 loc) · 3.21 KB
Raw

Penn-Pal App Backend

We use the Strapi headless CMS for most of the backend development, together with a Postgres Database hosted publicly. For development it is best to have a local database for testing purposes. Instructions on how to start with Strapi are below.

Notes for Development

This code has been configured so that it can be run locally with a local Postgres database. To develop with a local database, configure with the proper environment variable ENV_PATH as follows:

ENV_PATH=/Users/<username>/penn-pal-backend/.env.dev yarn develop

Please substitute with the one used on your Mac. It is assumed that you already have a ".env.dev" file set up for storing the desired environment variable values like the below:

HOST=0.0.0.0
PORT=1337

DATABASE_HOST=127.0.0.1
DATABASE_PORT=5432
DATABASE_NAME=tobemodified
DATABASE_USERNAME=tobemodified
DATABASE_PASSWORD=tobemodified
DATABASE_SSL=false

APP_KEYS="toBeModified1,toBeModified2"
API_TOKEN_SALT=tobemodified
ADMIN_JWT_SECRET=tobemodified
JWT_SECRET=tobemodified

🚀 Getting started with Strapi

Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.

develop

Start your Strapi application with autoReload enabled. Learn more

npm run develop
# or
yarn develop

start

Start your Strapi application with autoReload disabled. Learn more

npm run start
# or
yarn start

build

Build your admin panel. Learn more

npm run build
# or
yarn build

⚙️ Deployment

Strapi gives you many possible deployment options for your project. Find the one that suits you on the deployment section of the documentation.

📚 Learn more

  • 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.