Figma: https://www.figma.com/file/LCgTUgVNpKKMQQ3xlAca4p/frontendship?node-id=0%3A1
Getting Started
Contribute To The Project and Run Locally
To contribute:
Fork the project.
git clone https://github.com/<username>/website
Go to the project directory
cd website
Change the branch
git checkout development
Install dependencies
yarn
Start the development server
yarn dev
How to open a pull request
Make sure your fork repository is synced with remote (upstream, original) repository to avoid conflicts. You can either check here or simply use terminal codes below.
Syncing a fork branch
First add upstream with:
git remote add upstream https://github.com/fshipcommunity/website
Then to get upstream's updates run:
git fetch upstream
Check out your fork's local default branch:
git checkout <BRANCH_NAME>
Then merge upstream with your fork (local) repo:
git merge upstream/<BRANCH_NAME>
Example
git remote add upstream https://github.com/fshipcommunity/website
git fetch upstream
git checkout development
git merge upstream/development
Usage/Examples
import Header from "../components/Header";
function App() {
console.log("Hello world");
return <Header />;
}
Contributing
Contributions are always welcome!
See contributing.md
for ways to get started.