Skip to content

Latest commit

 

History

History
86 lines (53 loc) · 3.23 KB

README.md

File metadata and controls

86 lines (53 loc) · 3.23 KB
Raw

Introduction to the README Template

Hare Krishna! Welcome to the PS README template. Please fill out this template on how your project is/was developed and deployed to create documentation. The storage of information in one place is very useful and also ensures all the information is present for the future.

Please keep this template structure and do not remove any sections. Feel free to add subsections under the existing headings. If any sections do not apply, please leave them intact, for future use. Do not hesitate to contact the current maintainer ([email protected]) if you have any questions or queries. Please also feel free to submit a Pull Request to improve this template.

This template should be used to create the README.md file in your project repository. The file properly starts below! ⬇️

Project Name

Live site at: example.com <- Update this

Table of Contents 📚

Please use gh-md-toc to create and update your table of contents. Make sure you leave the ts and te comments above as that's what gh-md-toc uses to generate the table of contents

You can use the following command to generate the TOC:

gh-md-toc --insert --no-backup README.md

Description and Purpose 📝

Please add a longer description of your project here.

Intended Audience 🎭

Please describe who your intended audience is here

People of Contact 👤

Please fill in this table and add any other important people who may need to be contacted in the future.

Title Name Email Phone
Project Owner/Creator Firstname Lastname [email protected] 0123456789
Server setup/hosting Firstname Lastname [email protected] 0123456789
Managed/maintained by Firstname Lastname [email protected] 0123456789
Emergency Contact Firstname Lastname [email protected] 0123456789

Technologies, Dependencies, and Notable Libraries 👾

  • Please use a bullet list
  • To list all the
    • technologies,
    • dependencies,
    • libraries
  • used in the project

How to Run Project 🏃

Please provide detailed instructions with a step by step guide on how to run the project here, including any .env file instructions and configurations, as well as where the environment variables come from.

Admin Credentials 🕴

Please provide any admin credentials for the project here, including credentials for external providers (e.g. google cloud or mongodb)

Main App Login:

Username: admin
Password: admin

Email for Project 📧

If the project uses emails in any way, please request/provide information about the email system being used. The email credentials and connection options are to be stored here

Deployment & Costs 💰

Please provide any costs for APIs, services, etc. here.

Technology Cost
PS Server for hosting _
Emails _
Any cloud Solutions _

Backups 🧯

Please provide information on how any data the project stores is being backed up, or add details requesting certain parts of the project to be backed up