postit

This is a basic social platform with a clean design, authentication, and personalized content. The client uses a separately built and hosted api to manage the logic behind the scenes safely and fast.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact

About The Project

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/martjn/postit.git

2. Install NPM packages

   npm install

3. Create a local instance of your database
4. Create .env file inside the server directory with the following

   DB_USERNAME=your_database_username
   DB_PASSWORD=your_database_password
   DB_DATABASE=your_database_name
   DB_HOST=localhost // default
   DB_DIALECT=your_database_dialect // ex. mysql  whichever SQL language you use.
   DB_PORT=your_port // custom port that differs from your client/frontend port

5. Inside your server directory, start the server

npm start

Try blasting the server with information using postman for example

Api docs available at: https://full-stack-api-pmvb.onrender.com/api-docs/

For ex. To get all posts, use http://localhost:your_port/posts endpoint

!important: if you want to use endpoints that CRUD your data in any way (without a client), you need a valid generated webtoken. Create one by registering user via auth/auth endpoint, and then logging in using auth/login endpoint

(Optional)

If you wish to also use the postit client, do the following:

1. Move to your client directory via console
2. Start the client

npm start

It should take a few minutes to compile. And that's it.

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Martin Toming - @marttintom - mingdev77@gmail.com

Project Link: https://github.com/martjn/postit

(back to top)