FontFound API is a backend service built using TypeScript, NestJS, and Prisma, designed to power the FontFound application. This repository provides a fully containerized environment using Docker and an automated CI/CD pipeline with GitHub Actions for deployment to Google Cloud Run.
- NestJS Framework: Modular and efficient API architecture.
- Prisma ORM: Powerful database interaction with schema-based type safety.
- Docker Support: Consistent and portable containerized deployments.
- GitHub Actions: Streamlined CI/CD for automated testing and deployment.
- Google Cloud Run: Serverless application hosting with scalable infrastructure.
To set up the project locally or for deployment, ensure the following tools are installed:
-
Node.js (v16 or higher)
-
Docker
-
Google Cloud SDK
-
Git
To configure the project, create a .env file in the root directory. Add the following environment variables:
# Database connection URL
DATABASE_URL=your_database_connection_url
# Google Cloud Project credentials
PROJECT_ID=your_google_cloud_project_id
PRIVATE_KEY="your_google_cloud_service_account_private_key"
CLIENT_EMAIL=your_google_cloud_service_account_email
# Google Cloud Storage
STORAGE_MEDIA_BUCKET=your_google_cloud_storage_bucket_name- Clone the Repository
git clone https://github.com/your-username/fontfound-api.git
cd fontfound-api- Install Dependencies
npm install- Run Database Migrations
npx prisma migrate dev- Start the Development Server
npm run start:dev- Access the API Open your browser or API client at:
http://localhost:<your port>## License
This project is licensed under the MIT License.
MIT License
-----------
Copyright (c) 2024 FontFound
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.