Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elliotjreed/www.nexusbusiness.co.uk
https://github.com/elliotjreed/www.nexusbusiness.co.uk
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elliotjreed/www.nexusbusiness.co.uk
- Owner: elliotjreed
- License: mit
- Created: 2020-10-06T19:34:32.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-21T17:44:43.000Z (over 2 years ago)
- Last Synced: 2023-03-02T04:22:15.884Z (almost 2 years ago)
- Language: TypeScript
- Size: 2.27 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/elliotjreed/www.nexusbusiness.co.uk) [](https://coveralls.io/github/elliotjreed/www.nexusbusiness.co.uk?branch=master)
# NexusBusiness.co.uk
The website source code for NexusBusiness.co.uk.
## PHP API Backend
PHP 7.4 or above and Composer is expected to be installed on our system.
The backend API is located under the `./api` directory.
### Installing Composer
For instructions on how to install Composer visit [getcomposer.org](https://getcomposer.org/download/).
### Installing for Development
After cloning this repository, change into the newly created directory and the subdirectory `api` and run
```
composer install
```
or if you have installed Composer locally
```
php composer.phar install
```
This will install all dependencies needed for the project.
## Running the Tests
All tests can be run by executing
```
vendor/bin/phpunit
```
`phpunit` will automatically find all tests inside the `test` directory and run them based on the configuration in the `phpunit.xml` file.
## Typescript Frontend
### Installing Yarn
For instructions on how to install Yarn visit [yarnpkg.com](https://yarnpkg.com/lang/en/).
### Installing dependencies
The frontend uses Typescript and SASS, and is bundled using Webpack.
To install the required dependencies, change into the `./frontend` subdirectory and run
```
yarn install
```
### Running for development
To run the Webpack development server run:
```
yarn start
```
### Building for production
To build the production-optimised application run:
```
yarn build
```
## Deployment
Deployment is via Docker and Docker Compose.
## Built With
- [PHP](https://secure.php.net/)
- [Composer](https://getcomposer.org/)
- [PHPUnit](https://phpunit.de/)
- [Typescript](https://www.typescriptlang.org/)
- [Yarn](https://yarnpkg.com/lang/en/)
- [Webpack](https://webpack.js.org/)
## License
This project is licensed under the MIT License - see the [LICENCE](LICENCE) file for details.