Skip to content

Commit

Permalink
removed recaptcha
Browse files Browse the repository at this point in the history
updated readme for new update
  • Loading branch information
Vogeslu committed Jan 21, 2022
1 parent 44c89e8 commit 31e6841
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 75 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This project uses [TwitterOAuth](https://github.com/abraham/twitteroauth) by [ab

# Installation

To install Sociant Hub for your own use make sure you use PHP 7.4, a [MySQL Database](https://mysql.com/) or higher and have [Composer](http://packagist.org/) installed.
To install Sociant Hub for your own use make sure you use [PHP 8.0](https://www.php.net/releases/8.0/en.php), a [MySQL Database](https://mysql.com/) or higher, [NodeJS 16](https://nodejs.org/en/) with npm and have [Composer](http://packagist.org/) installed.

### 1. Clone the repository

Expand All @@ -26,7 +26,13 @@ Clone with SSH: [email protected]:Sociant/Sociant-Hub.git

Run `composer require`

### 3. Configure the application
### 3. Install dependencies with npm

Run `npm install` or `yarn install`

Warning: Sociant Hub uses fontawesome 5 pro packages which require a subscription.

### 4. Configure the application

Copy the contents of the given `.env` file into a new file called `.env.local`. To operate Sociant Hub properly you should fill out every given field.

Expand All @@ -38,9 +44,6 @@ MAILER_DSN | DSN Settings for E-Mail delivery || Please consider checking out th
TWITTER_API_KEY | Public Twitter API Key || Please visit [Twitter Developer](https://developer.twitter.com/en/apps) for obtaining the key pair
TWITTER_API_SECRET_KEY | Secret Twitter API Key || Read above
TWITTER_CALLBACK_URL | Return URL after successful authentication || Read above
REPATCHA_PUBLIC | Public Recaptcha Key for Contact Page || Please visit [Recaptcha Admin](https://www.google.com/recaptcha/admin) for obtaining the key pair
REPATCHA_SECRET | Secret Recaptcha Key for Contact Page || Read above
RECIPIENT_EMAIL | Recipient E-Mail for Contact Page || [email protected]
MOBILE_PLATFORM_SCHEMA | Schema Redirection after Login from mobile Device | socianthub://callback
FOLLOWER_LIMIT | Follower Limit for Follower Analytics | 70000

Expand All @@ -53,11 +56,11 @@ https://console.firebase.google.com/project/[your-project-id]/settings/serviceac

Go to Firebase Admin SDK and click on generate new private key. (or use your already generated one) and copy the contents into your project-credentails.json

### 4. Run Symfony
### 5. Run Symfony

You can either run symfony via console with `symfony server:start` or run it via Apache or Nginx. Visit [Configuring a Web Server](https://symfony.com/doc/current/setup/web_server_configuration.html) for more information.

### 5. That's it
### 6. That's it

Now you can Login from your given URL or local Port to visit your instance.

Expand All @@ -71,13 +74,21 @@ Or you can update your data manually in the dashboard or for every user with `ph

Please consider that due to API limitations you can only update every user once per hour.

# Used Plugins
# Used Libraries

### Composer Libraries (PHP)
* [TwitterOAuth](https://github.com/abraham/twitteroauth) by [abraham](https://github.com/abraham)
* [Firebase Bundle](https://github.com/kreait/firebase-bundle) by [kreait](https://github.com/kreait)
* [DoctrineExtensions](https://github.com/beberlei/DoctrineExtensions) by [beberlei](https://github.com/beberlei)
* [CronBundle](https://github.com/Cron/Symfony-Bundle) by [cron](https://github.com/Cron)
* [Recaptcha](https://github.com/google/recaptcha) by [Google](https://github.com/google)

### NPM Libraries (NodeJS)
* [FontAwesome](https://fontawesome.com/) by [Fortawesome](https://fontawesome.com/)
* [ApexCharts](https://github.com/apexcharts/apexcharts.js) by [ApexCharts](https://github.com/apexcharts)
* [Framer Motion](https://github.com/framer/motion) by [Framer](https://github.com/framer)
* [i18next](https://github.com/i18next/i18next) by [i18next](https://github.com/i18next)
* [React Router](https://github.com/remix-run/react-router) by [remix-run](https://github.com/remix-run)
* [Styled Components](https://github.com/styled-components/styled-components) by [styled components](https://github.com/styled-components)

# License

Expand All @@ -88,3 +99,7 @@ Sociant Hub is released under the [Apache-2.0](license.md) License
Sociant Hub was created by [l9cgv](https://twitter.com/l9cgv) as Project for [SociantWD](https://twitter.com/SociantWD).

Thanks to [DeZio91](https://twitter.com/DeZio91) and [Marcel Malberg](https://twitter.com/TheCrealm) for testing out the application in beta state.

Thanks to everyone involved in version 1 and users of the Sociant Hub App. <3

Copyright © 2022 - Sociant WD
1 change: 0 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
"doctrine/doctrine-bundle": "^2",
"doctrine/doctrine-migrations-bundle": "^2",
"doctrine/orm": "^2",
"google/recaptcha": "~1.1",
"kreait/firebase-bundle": "^2.3",
"kreait/firebase-php": "^5.14",
"phpdocumentor/reflection-docblock": "^5.2",
Expand Down
54 changes: 1 addition & 53 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions config/services.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ parameters:
twitter_api_secret_key: '%env(TWITTER_API_SECRET_KEY)%'
twitter_callback_url: '%env(TWITTER_CALLBACK_URL)%'
mobile_platform_schema: '%env(MOBILE_PLATFORM_SCHEMA)%'
recaptcha_secret: '%env(REPATCHA_SECRET)%'
recaptcha_public: '%env(REPATCHA_PUBLIC)%'
recipient_email: '%env(RECIPIENT_EMAIL)%'
follower_limit: '%env(FOLLOWER_LIMIT)%'

services:
Expand Down
9 changes: 0 additions & 9 deletions symfony.lock
Original file line number Diff line number Diff line change
Expand Up @@ -126,15 +126,6 @@
"google/crc32": {
"version": "v0.1.0"
},
"google/recaptcha": {
"version": "1.1",
"recipe": {
"repo": "github.com/symfony/recipes-contrib",
"branch": "master",
"version": "1.1",
"ref": "d087df3e087f50da3955f2def05079380da5894b"
}
},
"guzzlehttp/guzzle": {
"version": "7.2.0"
},
Expand Down

0 comments on commit 31e6841

Please sign in to comment.