Skip to content

Latest commit

 

History

History
137 lines (105 loc) · 5.11 KB

README.md

File metadata and controls

137 lines (105 loc) · 5.11 KB
Raw

GitHub Contributors GitHub Forks GitHub Stargazers GitHub Issues MIT License Join the Conversation on Discord Follow us on LinkedIn


nor(DEV): Logo

nor(DEV): Website

The Repo for the Website at https://www.norfolkdevelopers.com

Table of Contents

Introduction

Hi! We're Norfolk Developers and you're awesome for just being here. We're a community of Developers based in and around Norfolk in the UK.

And this? This is our website! It's a community project, and we welcome contributors, particularly to our posts. The process of adding your articles to our website is fairly simple, they should be provided in markdown format and can be found in /src/pages/posts/.

If you'd like to get involved and are unsure how to then reach out to us, we'd be happy to help onboard you. Give us a hola on Discord, Twitter, LinkedIn!

Built With

Getting Started

Getting started is fairly simple, you just need NodeJS >= 14.x

Prerequisites

Install NodeJS 14.x, we recommend using Node Version Manager to do this:

  • NodeJS 14.x
nvm use 14

Installation

  1. Clone the repo
git clone [email protected]:NorfolkDev/norfolkdevelopers-website.git
cd norfolkdevelopers-website/
  1. Install NPM packages
npm install

Usage

In the same directory you cloned the repo into, launch the dev server:

npm run dev

Now visit http://localhost:3000 in your browser

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request
  6. Give yourself a high five, or seek one from an unexpecting colleague

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Norfolk Developers - @NorfolkDev - [email protected]