README.md

WakaLie

Don't keep your thoughts to yourself, welcome to WakaLie.

WakaLie is basically an open source text posting platform still in the early stages of development.

⚡ Prerequisites

• Node and npm

  • Install using this tutorial for linux/mac and windows

• MongoDB compass and MongoDB

  • Follow instructions from the docs

🔧 Setting up the Project

1. Fork repository

2. Clone the forked repository in prefered directory

   git clone <project-url>

3. Enter project directory

   cd Wakalie

4. Initialize project

   git init

🔮 Running the project

1. Install dependencies

   npm install

2. Start react app (in root of the project folder)

   npm start

3. Goto backend

   cd Backend

4. Start server

   nodemon server

🚀 Roadmap

• Build frontend of base pages
• Build a pre-database that would be used for development
• Implement sign up
• Implement log in
• Remove certain routes for unauthorised users
• Save picture when signing up
• Implement basic functionalities like posting and updating profile
• User pages
• more to come...
• Lastly, host project
• Futher maintainance

🤝 Contributing

If you want to contribute to this project, simply follow the steps in the contribution guide. I look forward to your contributions. 😎 CONTRIBUTING.md

🙌 Show your support

Give a ⭐️ if this project helped you!