Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(website): add new website page and rename folder #52

Merged
merged 1 commit into from
Apr 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
49 changes: 49 additions & 0 deletions docs/development-projects/website.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Website Development

## Introduction
A guide that will help you get through the basics on getting started with development of the FlyByWire Simulations marketing website.

## Prerequisites
- [NodeJS](https://nodejs.org/en/)

## Recommended Tools
- [Git](https://git-scm.com/) - A free and open source version control system.
- [Figma](https://www.figma.com/) - A free prototyping tool used to conceptualize UI designs and make mockups for desktop and mobile.
- [VSCode](https://code.visualstudio.com/) - A free code editor designed to make working with various languages quick and easier.
- [JetBrains](https://www.jetbrains.com/) - A paid IDE with an educational scheme. For more information on how to obtain a free license check [here](https://www.jetbrains.com/edu-products/).

## Relevant Documentation
A list of relevant documentation regularly used to aid the development of the website.

- [Next.js](https://nextjs.org) used to build our page.
- [React](https://reactjs.org/) javascript library used to make UI.
- [tailwindcss](https://tailwindcss.com/) low level CSS classes.

## Getting Started
Although there are no requirements to getting started, having basic knowledge on Git, HTML, CSS and JavaScript will benifit anyone who decides to contribute towards the website.

Clone the repository to a safe place on your machine
```sh
git clone https://github.com/flybywiresim/website.git
```

Install dependencies
```sh
npm install
```

Start development server
```sh
npm run dev
```

Start a production server
```sh
npm run build
npm run start
```
To build the website for production, run the following commands.
```sh
npm run build
npm run export
```
15 changes: 8 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ nav:
- Sounds: sdk/sounds.md
- Modeling: sdk/modeling.md
- Texturing: sdk/texturing.md
- Common Development:
- Overview: common-dev/overview.md
- Blender Plugin: common-dev/blender.md
- EFB: common-dev/efb.md
- Installer: common-dev/installer.md
- Rust SDK: common-dev/msfs-rs.md
- Web API: common-dev/web-api.md
- Development Projects:
- Overview: development-projects/overview.md
- Blender Plugin: development-projects/blender.md
- EFB: development-projects/efb.md
- Installer: development-projects/installer.md
- Rust SDK: development-projects/msfs-rs.md
- Website: development-projects/website.md
- Web API: development-projects/web-api.md
- A32NX Development:
- Overview: a32nx-dev/overview.md
- HTML/JS Code: a32nx-dev/html.md
Expand Down