matefeed

Self-hosteable social network

Development

Requirements

• Docker and Docker Compose
• NodeJS

Getting Started

1. Clone this repository

git clone https://github.com/matefeed/matefeed.git

2. Build Docker images using Docker Compose

docker-compose up

3. In a separate terminal session, install project dependencies.

It's recommended to use PNPM to manage packages in this project. You can install it using npm by running: npm install -g pnpm

pnpm install

4. Run database migrations. Step 1 is required for this step to be accomplished with success.

pnpm run knex migrate:latest

5. Run the server

pnpm run dev

The project must be available on http://localhost:3000.

Icons

This application uses Feathericons to provide icons. You must import them from the react-feather module and use them as specified here: https://github.com/feathericons/react-feather.

GraphQL

GraphQL is used.

The playground is available on: http://127.0.0.1:3000/graphiql.

Contributing

Every kind of contribution to this project is welcome, please, don't hesitate to open a Pull Request or Issue. I will be happy to help!