ShareScribe

Description

shareScribe is backend for a note taking app. It allows users to create, read, update, and delete notes and share them with other users.

Table of Contents

• TechStack
• CheckList
• Installation

TechStack

• Node.js
• Express
• PostgreSQL
• TypeORM
• TypeScript

CheckList

• User authentication with JWT
• Notes can be created, read, updated, and deleted
• Notes can be shared with other users
• Database migrations and ORM configuration using TypeORM
• Swagger documentation using Swagger UI Express and tsoa
• Docker Containerization
• Unit tests with Jest
• CI/CD with GitHub Actions
• Deployment to AWS

Installation

Prerequisites

• Node.js v18.0.0 or higher
• PostgreSQL v15.0.0 or higher

Running Without Docker Compose

• Fork the repo
• Clone the repo to your local machine
• Navigate to the root directory and run npm install to install dependencies
• Copy the .env.example file and rename it to .env
• Update the .env file with your database credentials
• Create a database in PostgreSQL with the name you specified in the .env file
• Run npm run db:generate to generate the migration files
• Run npm run migrations:run to run the migrations
• Run npm run dev-run to run the server in development mode
• Navigate to http://localhost:3000/api-docs to view the Swagger documentation

Running With Docker Compose

• Ensure Docker and Docker Compose are installed on your machine.
• Navigate to the root directory of the project.
• Create a .env file with your environment variables as specified in .env.example. For Docker, make sure the database host matches your service name for PostgreSQL in docker-compose.yml.
• Use Docker Compose to build and run the services: docker-compose up --build
• To stop the containers, you can use: docker-compose down
• Access the application as you would normally, with the Swagger documentation available at http://localhost:3000/api-docs.

Contributing

Contributions are welcome! Please create an issue if you find a bug you'd like to fix or a feature you think should be added. If you'd like to contribute code, please create a pull request and I will review it as soon as I can.