321-ch

• 🚀 Demo
• 🗒 Description
• ✨ Technologies
• 📌 Requirements
• 🔨 Usage
• 🏭 Contributing
• 📣 License

🚀 Demo

Link

🗒 Description

321ch is an imageboard engine built using React, Node.js, Typescript.

✨ Technologies

• Front End:

  • React
  • Redux
  • Typescript
  • SASS
  • Webpack

• Back End:

  • Node.js
  • Express
  • Typescript
  • Mongoose, Mongod DB

• Testing:

  • Jest
  • Sinon
  • Enzyme

📌 Requirements

You should have the latest version of mongodb and node.js installed on your machine. Mongodb is assumed to use the default port, username and password, but you can always change that in server/config/config.ts.

🔨 Setting up and running

Install client dependencies:

yarn install

Move to server folder:

cd server

Install server dependencies:

yarn install

Go back to root directory:

cd ..

Generate production bundle:

yarn run build-prod

Run tests to verify that everything is working smoothly:

yarn test

Finally, start the project:

yarn start

Voila! Both api and content server are running on port 3000. Visit localhost:3000 to view the website.

🏭 Contributing

1. Fork it ( https://github.com/olegStotsky/321-ch/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

📣 The MIT License (MIT)

Copyright (c) 2015 ID25

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.