This is the official repository for The tech directory, a platform that showcases the profiles of creatives in our ecosystem.
This process is for somewhat tech savvy individuals, in order to add your profile to the platform you'll need to:
- Create a fork this repo
- Create a branch
- In the
/src/data/users/
folder, create ajson
file with your preferred username as teh file name e.g. `samuel.json - Copy the contents of
/docs/template.json
and paste in your newly created file - Fill the content accordingly
- Commit your changes
- Push it to the fork of the repo
- Creat a PR to the
develop
branch on the main repo
If you need a feature and you don't have the time or knowledge to work on it, please submit an issue on the repo and we will try to get to it. If you can contribute, follow the steps below to get the project up and running
To get the project running, follow these steps:
- Create a folder
- Enter/Navigate into that folder
cd <folder-name>
- Clone this repository:
git clone https://github.com/samie820/dev-directory.git .
- Install all the project's dependencies:
yarn
- Once that's done, run the project:
yarn develop
- To build, run
yarn build
The app is currently deployed on Netlify and can be seen here
Whenever a PR is sent, Netlify triggers a build and generates a preview for you:
- Javascript
- Vue/Gridsome