mirror of
https://github.com/fsolla/teqo.git
synced 2026-11-12 22:13:05 +00:00
chore: update Teqo metadata and positioning
Align project metadata and documentation with Teqo's civic engagement mission, setting Codeberg as the primary source and clarifying the white-label product direction.
This commit is contained in:
parent
87ebb726d2
commit
a75ed510ca
2 changed files with 51 additions and 51 deletions
84
README.md
84
README.md
|
|
@ -1,67 +1,51 @@
|
|||
# Payload Blank Template
|
||||
# Teqo
|
||||
|
||||
This template comes configured with the bare minimum to get started on anything you need.
|
||||
Teqo starts as the official digital platform for **deputado Jorge Solla** and evolves into a **white-label civic engagement platform** for politicians in Brazil.
|
||||
|
||||
## Quick start
|
||||
The goal is to help political teams build direct, durable relationships with their base without depending on Big Tech social platforms as the primary channel.
|
||||
|
||||
This template can be deployed directly from our Cloud hosting and it will setup MongoDB and cloud S3 object storage for media.
|
||||
## Mission
|
||||
|
||||
## Quick Start - local setup
|
||||
- Strengthen direct communication between representatives and citizens.
|
||||
- Reduce platform dependency risk by owning audience and data channels.
|
||||
- Provide reusable building blocks so each political team can launch quickly.
|
||||
|
||||
To spin up this template locally, follow these steps:
|
||||
## Product Direction
|
||||
|
||||
### Clone
|
||||
### Phase 1: Jorge Solla Website
|
||||
|
||||
After you click the `Deploy` button above, you'll want to have standalone copy of this repo on your machine. If you've already cloned this repo, skip to [Development](#development).
|
||||
Initial delivery focuses on Jorge Solla's public website and communication workflows:
|
||||
|
||||
### Development
|
||||
- Public-facing content and updates
|
||||
- Institutional pages and biography
|
||||
- Media and campaign communication assets
|
||||
- Editorial operations through Payload CMS
|
||||
|
||||
1. First [clone the repo](#clone) if you have not done so already
|
||||
2. `cd my-project && cp .env.example .env` to copy the example environment variables. You'll need to add the `MONGODB_URL` from your Cloud project to your `.env` if you want to use S3 storage and the MongoDB database that was created for you.
|
||||
### Phase 2: White-Label Platform
|
||||
|
||||
3. `pnpm install && pnpm dev` to install dependencies and start the dev server
|
||||
4. open `http://localhost:3000` to open the app in your browser
|
||||
Teqo then becomes a configurable base product for other politicians in Brazil:
|
||||
|
||||
That's it! Changes made in `./src` will be reflected in your app. Follow the on-screen instructions to login and create your first admin user. Then check out [Production](#production) once you're ready to build and serve your app, and [Deployment](#deployment) when you're ready to go live.
|
||||
- Multi-tenant and reusable architecture
|
||||
- Brand and content customization per mandate/campaign
|
||||
- Shared core modules for communication and engagement
|
||||
- Operational autonomy with self-hosted owned channels
|
||||
|
||||
#### Docker (Optional)
|
||||
## Local Development
|
||||
|
||||
If you prefer to use Docker for local development instead of a local MongoDB instance, the provided docker-compose.yml file can be used.
|
||||
1. Copy environment variables: `cp .env.example .env`
|
||||
2. Install dependencies: `pnpm install`
|
||||
3. Start development server: `pnpm dev`
|
||||
4. Open: `http://localhost:3000`
|
||||
|
||||
To do so, follow these steps:
|
||||
## Tech Stack
|
||||
|
||||
- Modify the `MONGODB_URL` in your `.env` file to `mongodb://127.0.0.1/<dbname>`
|
||||
- Modify the `docker-compose.yml` file's `MONGODB_URL` to match the above `<dbname>`
|
||||
- Run `docker-compose up` to start the database, optionally pass `-d` to run in the background.
|
||||
- Payload CMS
|
||||
- Next.js
|
||||
- PostgreSQL (via `@payloadcms/db-postgres`)
|
||||
- TypeScript
|
||||
|
||||
## How it works
|
||||
## Roadmap Notes
|
||||
|
||||
The Payload config is tailored specifically to the needs of most websites. It is pre-configured in the following ways:
|
||||
|
||||
### Collections
|
||||
|
||||
See the [Collections](https://payloadcms.com/docs/configuration/collections) docs for details on how to extend this functionality.
|
||||
|
||||
- #### Users (Authentication)
|
||||
|
||||
Users are auth-enabled collections that have access to the admin panel.
|
||||
|
||||
For additional help, see the official [Auth Example](https://github.com/payloadcms/payload/tree/main/examples/auth) or the [Authentication](https://payloadcms.com/docs/authentication/overview#authentication-overview) docs.
|
||||
|
||||
- #### Media
|
||||
|
||||
This is the uploads enabled collection. It features pre-configured sizes, focal point and manual resizing to help you manage your pictures.
|
||||
|
||||
### Docker
|
||||
|
||||
Alternatively, you can use [Docker](https://www.docker.com) to spin up this template locally. To do so, follow these steps:
|
||||
|
||||
1. Follow [steps 1 and 2 from above](#development), the docker-compose file will automatically use the `.env` file in your project root
|
||||
1. Next run `docker-compose up`
|
||||
1. Follow [steps 4 and 5 from above](#development) to login and create your first admin user
|
||||
|
||||
That's it! The Docker instance will help you get up and running quickly while also standardizing the development environment across your teams.
|
||||
|
||||
## Questions
|
||||
|
||||
If you have any issues or questions, reach out to us on [Discord](https://discord.com/invite/payload) or start a [GitHub discussion](https://github.com/payloadcms/payload/discussions).
|
||||
- Prioritize audience ownership and portability of data.
|
||||
- Keep modules generic enough for reuse across different political contexts.
|
||||
- Default to secure, access-controlled features for campaign and institutional teams.
|
||||
|
|
|
|||
18
package.json
18
package.json
|
|
@ -1,7 +1,23 @@
|
|||
{
|
||||
"name": "teqo",
|
||||
"version": "1.0.0",
|
||||
"description": "A blank template to get started with Payload 3.0",
|
||||
"description": "White-label civic engagement platform for Brazilian politicians, launched with deputado Jorge Solla.",
|
||||
"keywords": [
|
||||
"politics",
|
||||
"brazil",
|
||||
"civic-engagement",
|
||||
"white-label",
|
||||
"payload-cms"
|
||||
],
|
||||
"homepage": "https://codeberg.org/fsolla/teqo",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://codeberg.org/fsolla/teqo.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://codeberg.org/fsolla/teqo/issues"
|
||||
},
|
||||
"author": "Francisco Solla",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
|
|
|||
Loading…
Reference in a new issue