Project Overview 🎉

826 Boston is a nonprofit youth publishing organization where students in grades K-12 can share their stories and amplify their voices as writers.

A lot of hard work and organization is required for publishing an anthology of student works! There are a lot of steps in betwen the students first writing drafts and the final production and sale of a bound book - plus a final celebratory author signing event. There are many students, volunteers, educators, and community partners involved in this process. Code 4 Community is creating an internal administrative system to ease and organize the publishing process. Volunteers will be able to log on and see their upcoming tasks on different projects. 826 administrators will be able to create projects, delegate tasks, and track progress in real time.

Tech Stack 📦

• Front-end: React
• Back-end: Typescript
• Database: PostgreSQL
• Cloud provider: AWS

Setup

Clone this repo and run yarn at the root to install this project's dependencies.

You can optionally install nx globally with npm install -g nx - if you don't, you'll just need to prefix the commands below with npx (e.g. npx nx serve frontend).

Start the app

To start the development server run nx serve frontend. Open your browser and navigate to http://localhost:4200/. Happy coding!

Running tasks

To run just the frontend (port 4200):

nx serve frontend

To run just the backend (port 3000):

nx serve backend

To run both the frontend and backend with one command:

nx run-many -t serve -p frontend backend

Test new migrations and seed data

yarn db:reset.

You may need to reconnect to the database in pgadmin to see the changes

Pull the latest changes from the component library

Run git submodule update --remote

Folder Structure

This is an Nx monorepo, like all c4c reops. The main app code lives in apps/.

Backend (apps/backend/src)

Organized by module, each with its own controller, service, entity, and DTO (Data Transfer Object, that defines the shape of data being sent between the client and the API or between backend classes):

• anthology/, author/, story/, story-draft/, omchai/, inventory/, inventory-holding/, production-info/, users/, auth/ are all modules
• migrations/ — TypeORM migrations
• seeds/ — seed data and seed scripts (see yarn db:reset above)
• aws/ — AWS S3 integration (for seeding image data of anthology book covers)
• interceptors/ — cross-cutting request/response logic (e.g. current-user.interceptor.ts attaches the authenticated user to the request)
• strategies/ — cross-cutting configuration logic (e.g. plural-naming.strategy.ts defines how TypeORM derives table names from entity classes)

Frontend (apps/frontend/src)

• containers/ — route-level views (e.g. auth/, people/, resources/, archived-publications/, projects-publication/)
• components/ — shared UI components
• api/ — API client and shared DTOs - makes requests to backend
• hooks/ — custom React hooks
• assets/ — icons and images
• utils/ — helpers (e.g. router.ts, mock-data.ts)

Scaffolding

✨ This workspace has been generated by Nx, a Smart, fast and extensible build system. ✨

When cloning the repo, make sure to add the --recurse-modules flag to also clone the component library submodule (e.g. git clone --recurse-submodules https://github.com/Code-4-Community/scaffolding.git for the scaffolding repo)