Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FreeFeed/freefeed-server
FreeFeed server
https://github.com/FreeFeed/freefeed-server
freefeed friendfeed
Last synced: 2 months ago
JSON representation
FreeFeed server
- Host: GitHub
- URL: https://github.com/FreeFeed/freefeed-server
- Owner: FreeFeed
- License: mit
- Created: 2015-05-09T15:06:20.000Z (over 9 years ago)
- Default Branch: stable
- Last Pushed: 2024-08-23T09:31:03.000Z (5 months ago)
- Last Synced: 2024-08-23T13:10:37.038Z (5 months ago)
- Topics: freefeed, friendfeed
- Language: JavaScript
- Homepage: https://freefeed.net
- Size: 20.5 MB
- Stars: 42
- Watchers: 13
- Forks: 18
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.fossa.io/projects/git%2Bgithub.com%2FFreeFeed%2Ffreefeed-server?ref=badge_shield)
# FreeFeed Server
FreeFeed is a social network that enables you to discover and discuss the interesting
stuff your friends find on the web.
FreeFeed is being built as a replacement for FriendFeed, the real-time aggregator and social network
where "likes" for user generated content were implemented for the first time.
FreeFeed is based on [Pepyatka](https://github.com/pepyatka/pepyatka-server/) project
## Getting started with FreeFeed on macOS
### Set up dependencies via Homebrew
```
brew install redis
redis-server /usr/local/etc/redis.conf
brew install graphicsmagick
brew install postgres
brew services start postgresql
createuser -P -s freefeed (enter freefeed as password)
createdb -O freefeed freefeed
```
### Or set up dependencies using Docker
1. `brew install graphicsmagick`
1. [Install and run Docker](https://www.docker.com/get-started)
1. docker-compose up -d
### Then prepare Node.js environment and the app
1. Set up JS dependencies:
```
brew install nvm
brew install yarn
nvm install
yarn install
yarn knex --env production migrate:latest
mkdir ./public/files/attachments/thumbnails/ && mkdir ./public/files/attachments/thumbnails2/
```
2. Create temporary directories for attachments:
```
mkdir -p /tmp/pepyatka-media/attachments/thumbnails
mkdir -p /tmp/pepyatka-media/attachments/thumbnails2
mkdir -p /tmp/pepyatka-media/attachments/anotherTestSize
```
3. Create config `config/local.json` with some random secret string: `{ "secret": "myverysecretstring" }`.
4. Now you are ready to run the FreeFeed server:
```
yarn start
```
### Custom configuration
If you have other PostgreSQL (or any other) settings than default, you should configure FreeFeed server in a proper way.
The FreeFeed server uses [node-config](https://github.com/lorenwest/node-config) for configuration. You can create your own local configuration file to override any of default values. See the [Configuration Files](https://github.com/lorenwest/node-config/wiki/Configuration-Files) page of node-config documentation for details.
The default configuration is defined in `config/default.js` file. The `config/test.js` and `config/default-travis.json` files can be used as an example of customized configurations (for the 'test' and Travis CI environments accordingly).
## Testing
1. Create a Postgres database `freefeed_test`:
- if using local Postgres: run locally `createdb -O freefeed freefeed_test`
- if using Docker: open a terminal to the Docker container, run Postgres CLI (`psql -U freefeed`), then create the database (`create database freefeed_test;`)
- or use any other appropriate method such as pgAdmin
1. `yarn test`
## Testing docker image
```
make image
docker compose up -d
make docker-run
```
## Pushing docker image
[Get personal access token](https://github.com/settings/tokens) with `write:packages` and `read:packages` scopes.
```
docker login docker.pkg.github.com -u USERNAME -p TOKEN
make push
```
## Database migrations
If you're getting errors related to database structure or relations, run `yarn knex --env production migrate:latest` to run migrations
## Contribute
1. [How to contribute](https://freefeed.net/dev)
## Questions or need help?
You can drop your question [here](https://freefeed.net/support).
## Copyright and license
FreeFeed is licensed under the MIT License.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2FFreeFeed%2Ffreefeed-server?ref=badge_large)