prepare for 2.0.0 release

This commit is contained in:
Tao Bror Bojlén 2019-07-20 13:01:56 +03:00
parent 2cae5dccbf
commit 7aa914ab3f
No known key found for this signature in database
GPG key ID: C6EC7AAB905F9E6F
6 changed files with 43 additions and 28 deletions

View file

@ -1,32 +1,31 @@
# Software Bill of Materials # Software Bill of Materials
This is an overview of the external software components (libraries, etc.) that This is an overview of the external software components (libraries, etc.) that
are used in fediverse.space, or that are likely to be used. are used in fediverse.space.
## Backend ## Backend
I am currently in the process of migrating from a Python and Django-based
backend to one written in Elixir. This list is what *will* be used in the near
future.
### Crawler and API ### Crawler and API
* [Elixir](https://elixir-lang.org/) (the language) * [Elixir](https://elixir-lang.org/) (the language)
* [Phoenix](https://phoenixframework.org/) (the web framework) * [Phoenix](https://phoenixframework.org/) (the web framework)
* [HTTPoison](https://hexdocs.pm/httpoison/readme.html) (for crawling servers)
* See [/backend/mix.env](/backend/mix.env) for a complete overview of * See [/backend/mix.env](/backend/mix.env) for a complete overview of
dependencies dependencies
### Graph layout ### Graph layout
* Java (the language)
* Gradle (to build)
* [Gephi toolkit](https://gephi.org/toolkit/) * [Gephi toolkit](https://gephi.org/toolkit/)
## Frontend ## Frontend
* [React](https://reactjs.org/) (the UI framework) * [React](https://reactjs.org/) (the UI framework)
* [Blueprint](https://blueprintjs.com/) (a collection of pre-existing UI components) * [Blueprint](https://blueprintjs.com/) (a collection of pre-existing UI components)
* [Sigma.js](http://sigmajs.org/) (for graph visualization) * [Cytoscape.js](http://js.cytoscape.org/) (for graph visualization)
* See [/frontend/package.json](/frontend/package.json) for a complete overview * See [/frontend/package.json](/frontend/package.json) for a complete overview
of dependencies of dependencies
## Other ## Other
* [Docker](https://www.docker.com/) and * [Docker](https://www.docker.com/) and
[docker-compose](https://docs.docker.com/compose/overview/) [docker-compose](https://docs.docker.com/compose/overview/)
* The backend is deployed using [Dokku](http://dokku.viewdocs.io/dokku/).
* The frontend is hosted on [Netlify](https://www.netlify.com/) * The frontend is hosted on [Netlify](https://www.netlify.com/)
* [GitLab](https://gitlab.com/) and GitLab CI/CD are used for project management and CI/CD.

View file

@ -1,18 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security
## [1.0.0] - 2018-09-01
### Added
- Initial release. The date above is inaccurate; this first version was released sometime in the fall of 2018.
- This release had a Django backend and a [Sigma.js](http://sigmajs.org/) graph.

34
CHANGELOG.md Normal file
View file

@ -0,0 +1,34 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security
## [2.0.0] - 2019-07-20
### Added
- The backend has been completely rewritten in Elixir for improved stability and performance.
- An "insularity score" was added to show the percentage of mentions to users on the same instance.
- The crawler now respects robots.txt.
### Changed
- Migrated the frontend graph from Sigma.js to Cytoscape.js.
- To improve performance, instances with no neighbors are no longer shown on the graph.
### Deprecated
- The /api/v1 endpoint no longer exists; now there's a new /api.
### Removed
### Fixed
### Security
- Spam domains can be blacklisted in the backend crawler's config.
- Add basic automated security scanning (using [Sobelow](https://github.com/andmarti1424/sc-im.git) and Gitlab's dependency scanning).
## [1.0.0] - 2018-09-01
### Added
- Initial release. The date above is inaccurate; this first version was released sometime in the fall of 2018.
- This release had a Django backend and a [Sigma.js](http://sigmajs.org/) graph.

View file

@ -1,5 +1,5 @@
defmodule Backend.Api do defmodule Backend.Api do
alias Backend.{Crawl, Edge, Instance, Repo} alias Backend.{Edge, Instance, Repo}
import Backend.Util import Backend.Util
import Ecto.Query import Ecto.Query

View file

@ -4,7 +4,7 @@ defmodule Backend.MixProject do
def project do def project do
[ [
app: :backend, app: :backend,
version: "2.0.0-beta.1", version: "2.0.0",
elixir: "~> 1.5", elixir: "~> 1.5",
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
compilers: [:phoenix, :gettext] ++ Mix.compilers(), compilers: [:phoenix, :gettext] ++ Mix.compilers(),

View file

@ -1,6 +1,6 @@
{ {
"name": "frontend", "name": "frontend",
"version": "0.1.0", "version": "2.0.0",
"private": true, "private": true,
"scripts": { "scripts": {
"start": "NODE_ENV=development react-scripts start", "start": "NODE_ENV=development react-scripts start",