Birdi is a bird sighting application that allows bird enthusiasts and ornithologists to record and track their bird sightings. This guide provides detailed instructions for developers who want to set up and run Birdi locally.
Prerequisites Before getting started, you should have the following tools installed on your system:
- Git
- Node.js and npm
- TypeScript
- nodemon
- Open your terminal and navigate to the directory where you want to store the Birdi repository.
- Clone the repository:
git clone <repo url>
- Navigate to the root directory of the cloned repository:
cd birdi/
- Install dependencies in client folder:
cd client/ npm i - Install dependencies in server folder:
cd ../server/ npm i
-
From server folder:
tsc build
dist folder will appear in server folder
-
From client folder:
tsc build
dist folder will appear in the client folder
- From the server folder:
Verify that 'Server listening on port PORT' and 'db connected' prints to the console.
npm run dev
- From the client folder:
The react app will open the default port.
npm run dev
We welcome contributions to Birdi from the community. If you are interested in contributing, please read our contribution guidelines and reach out to us at alexryanjones@gmx.com, contact.sethjplatt@gmail.com or zakariyya_ahmed@outlook.com.
For support with setting up and running Birdi locally, please contact us at alexryanjones@gmx.com, contact.sethjplatt@gmail.com or zakariyya_ahmed@outlook.com.
