Worksy

Your project's readme is as important to success as your code. For this reason you should put as much care into its creation and maintenance as you would any other component of the application.

If you are unsure of what should go into the readme let this article, written by an experienced Chingu, be your starting point - Keys to a well written README.

And before we go there's "one more thing"! Once you decide what to include in your readme feel free to replace the text we've provided here.

Own it & Make it your Own!

Demo

🚀 Try it live: Worksy

Dependencies

To run the project locally, you will need:

• Node.js
• PostgreSQL
• pgAdmin as a postgres GUI

Folder Structure

root/
├── README.md
├── package-lock.json
├── package.json
└── apps/
    ├── client/
    |   ├── .env.example
    |   ├── package.json
    |   ├── config/
    |   |   └── env.ts
    │   └── src/
    │       └── main.tsx
    └── server/
    |   ├── .env.example
        ├── package.json
        └── src/
            ├── server.ts
            ├── config/
            |   └── env.ts
            └── database/
                ├── db.ts
                ├── migrate.ts
                └── migrations/

Dev Setup

1. Install dependencies

   # from the root of the repo
   npm ci

2. Create a copy of .env.example called .env for each app and fill the value for each environment variable.

3. start the local database server. If this is your fist time:

   • add a new server with default settings and localhost as hostname
   • create a database using the database dialog

4. run database migrations

   # from the root of the repo, it defaults to --init
   npm run db:migrate
   # alternatively, you can run --reset if you want to undo and redo the migrations
   npm un db:migrate -- -- --reset

5. spin up client and server dev servers

   # from the root of the repo once again
   npm run client:dev
   npm run server:dev

Team Documents

You may find these helpful as you work together to organize your project.

• Team Project Ideas
• Team Decision Log

Meeting Agenda templates (located in the /docs directory in this repo):

• Meeting - Voyage Kickoff --> ./docs/meeting-voyage_kickoff.docx
• Meeting - App Vision & Feature Planning --> ./docs/meeting-vision_and_feature_planning.docx
• Meeting - Sprint Retrospective, Review, and Planning --> ./docs/meeting-sprint_retrospective_review_and_planning.docx
• Meeting - Sprint Open Topic Session --> ./docs/meeting-sprint_open_topic_session.docx

Our Team

Everyone on your team should add their name along with a link to their GitHub & optionally their LinkedIn profiles below. Do this in Sprint #1 to validate your repo access and to practice PR'ing with your team before you start coding!

• snowbytes: GitHub

• Anthony Tibamwenda: @AskTiba / LinkedIn

• Adewale Agboke: GitHub / LinkedIn

• Tunde Ademola Kujore: GitHub / LinkedIn

• Rachel Tipton: GitHub / LinkedIn

• Jannah Hardy: LinkedIn

• asiill: GitHub