Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 2.05 KB

readme.md

File metadata and controls

104 lines (69 loc) · 2.05 KB
Raw

Model Rockets Space

ModelRockets.Space is a home for model rocket and space nerds 🚀👨‍🚀👩‍🚀. It has several features such as

  • Forum
  • Learning Center
  • Blog
  • User Profiles
    • User Flight Log
    • User Photo Galleries

It is built with the Laravel framework.

Installing Locally

Clone the repo

git clone https://github.com/WyattCast44/modelrockets.space.git

Move into project

cd modelrockets

Copy the env file

Make sure you set your local credentials in your .env file.

cp .env.example .env

Install Composer dependencies

composer install

Install NPM dependencies (Optional)

yarn install

Run Front End Asset Build (Optional)

yarn dev

# or

yarn watch

Migrate the Database

Make sure you make created a database and update the env file

php artisan migrate --seed

Cloudinary

This project uses Cloudinary for hosting images uploaded by users, you should create a cloudinary app and set the relavant keys in the .env file

CLOUDINARY_API_KEY=
CLOUDINARY_CLOUD_NAME=
CLOUDINARY_API_SECRET=

Algolia

You can set up Laravel Scout with Algolia for search by adding the relevant keys to the .env file

SCOUT_QUEUE=true    
SCOUT_DRIVER=algolia
ALGOLIA_APP_ID=
ALGOLIA_SECRET=
ALGOLIA_SEARCH=

Syncing with Algolia

You can run the following command to resync models/content with Algolia

php artisan searchable:sync

Testing

php artisan test

There is a known issue when testing publishing articles, due to technical debt, when an article is published a thead is created in the Article Discussions board, but if this board and the ArticlesBot user does not yet exist, the thread will not be created, this will lead to unforeseen and difficult problems to debug. The solution right now is just to run php artisan migrate:fresh --seed which will create the board and user.